docs(query-language): align prose tables with BNF and modelStringPattern#583
Open
aorzelskiGH wants to merge 1 commit into
Open
docs(query-language): align prose tables with BNF and modelStringPattern#583aorzelskiGH wants to merge 1 commit into
aorzelskiGH wants to merge 1 commit into
Conversation
Fix several prose inconsistencies in query-language.adoc that contradict
the BNF grammar and modelStringPattern:
- Cast operator table
Removed duplicate $dateTime row and dropped the stray "$" prefix
from all entries (str, num, bool, hex, dateTime, time). The BNF
defines these as "str"/"num"/"hex"/"bool"/"dateTime"/"time"
without a $ prefix.
- $aas#submodels field table
Added the mandatory [<index>] segment to submodels so the
examples match the BNF production
"submodels" ( "[" [0-9]* "]" ) "." <ReferenceClause>
and the schema modelStringPattern.
- $aasdesc#submodelDescriptors field table
Same fix: added [<index>] to the submodelDescriptors prefix in
all rows (semanticId, supplementalSemanticIds, id, idShort,
endpoints).
- Comparison examples
Updated $aas#submodels references in the comparison-result
tables to $aas#submodels[] so they stay valid against the
tightened regex.
- idShort example
Corrected example "$aas#id" for the idShort row to "$aas#idShort".
- Limitations bullet
Expanded the list of fields available on SubmodelElements to
match the BNF (semanticId, supplementalSemanticIds, idShort,
value, valueType, language).
No BNF or schema changes.
Refs: Review Finding T-11
Made-with: Cursor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Align the prose tables in
query-language.adocwith the BNF grammar (grammar.bnf) and themodelStringPatternregex inschema.adoc. Redactional only; no grammar or schema change.Problem
Several descriptive tables in
query-language.adoccontradict the formal language:$str(...),$num(...), ... — the BNF defines them asstr(...)/num(...)/hex(...)/bool(...)/dateTime(...)/time(...)without a$prefix, and the row for$dateTimeis duplicated.$aas#submodelsfield table and example comparisons usesubmodelswithout the mandatory[<index>]segment, but the BNF production issubmodels ( "[" [0-9]* "]" ) "." <ReferenceClause>and the schema pattern issubmodels\[[0-9]*\]\.….$aasdesc#submodelDescriptors.*table likewise drops the[<index>]segment in every row.idShortrow is wrongly printed as$aas#id(copy-paste from the line above).semanticId,idShort,value,valueTypebut the BNF also allowssupplementalSemanticIdsandlanguageon$sme#.Solution
$dateTimerow and drop the$prefix in the cast table.[<index>]segment tosubmodelsandsubmodelDescriptorsin the field tables and the matching comparison examples.idShortexample.supplementalSemanticIdsandlanguage.Affected files
documentation/IDTA-01002-3/modules/ROOT/pages/query-language.adocReview notes
grammar.bnfandmodelStringPattern; please diff the tables against the regex inschema.adocto confirm.Refs: Review Finding T-11