Skip to content

add fragmentfieldidentifiers #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Martin187187 merged 2 commits into from
Apr 16, 2026
Merged

add fragmentfieldidentifiers #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a6a682
update filter implementation
Martin187187 Apr 7, 2026
64bb15f
added missing parameters
Martin187187 Apr 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions documentation/IDTA-01004/modules/ROOT/pages/changelog.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Major Changes:

* changed: <ReferenceAttribute> with more detailed definition in BNF Grammar and JSON Schema
* changed: <IdentifiableObject>, <ReferableObject>, <FragmentObject>, <DescriptorObject> with more detailed definition in BNF Grammar and JSON Schema
* added: Query Filter and FragmentFieldIdentifiers (https://github.com/admin-shell-io/aas-specs-api/issues/517)

Minor Changes:

Expand Down
1 change: 1 addition & 0 deletions documentation/IDTA-01004/modules/ROOT/partials/bnf/access-rule-model.bnf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,4 @@
( <UseObjectGroup> <ws> )*
( ( "FORMULA:" <ws> <logicalExpression> <ws> ) | ( <UseFormula> <ws> ) )
( "FILTER:" <ws> <SecurityQueryFilter> )?
( "FILTERLIST:" <ws> ( <SecurityQueryFilter> <ws> )* )?

Check warning on line 16 in documentation/IDTA-01004/modules/ROOT/partials/bnf/access-rule-model.bnf

View workflow job for this annotation

GitHub Actions / qodana

Typo 

Typo: In word 'FILTERLIST'

Check warning

Code scanning / QDJVMC

Typo Warning documentation

Typo: In word 'FILTERLIST'
45 changes: 36 additions & 9 deletions documentation/IDTA-01004/modules/ROOT/partials/bnf/access-rules.bnf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,10 @@
( <UseObjectGroup> <ws> )*
( ( "FORMULA:" <ws> <logicalExpression> <ws> ) | ( <UseFormula> <ws> ) )
( "FILTER:" <ws> <SecurityQueryFilter> )?
( "FILTERLIST:" <ws> ( <SecurityQueryFilter> <ws> )* )?

Check warning on line 16 in documentation/IDTA-01004/modules/ROOT/partials/bnf/access-rules.bnf

View workflow job for this annotation

GitHub Actions / qodana

Typo 

Typo: In word 'FILTERLIST'
Comment thread Fixed

Check warning

Code scanning / QDJVMC

Typo Warning documentation

Typo: In word 'FILTERLIST'

<SecurityQueryFilter> ::=
<FragmentObject> <ws>
( "FRAGMENT:" <FieldIdentifierFragment> <ws> )
( ( "CONDITION:" <ws> <logicalExpression> <ws> ) | ( <UseFormula> <ws> ) )

<ACL> ::=
Expand Down Expand Up @@ -72,10 +73,10 @@

<ReferableObject> ::=
"REFERABLE" <ws> "$sme" <IdentifierInstanceOrAll> "." <idShortPath>

<FragmentObject> ::=
"FRAGMENT" <ws> "$sme" <IdentifierInstanceOrAll> "." <idShortPath> ( <ws> <StringLiteral> )+

<FragmentObject> ::=
"FRAGMENT" <ws> <FragmentLiteral> <ws>

<DescriptorObject> ::=
"DESCRIPTOR" <ws> ("$aasdesc" | "$smdesc") <IdentifierInstanceOrAll>

Expand Down Expand Up @@ -199,18 +200,44 @@
<BoolLiteral> ::= "true" | "false"

<FieldIdentifier> ::= <FieldIdentifierAAS> | <FieldIdentifierSM> | <FieldIdentifierSME> | <FieldIdentifierCD> | <FieldIdentifierAasDescriptor> | <FieldIdentifierSmDescriptor>
<FieldIdentifierAAS> ::= "$aas#" ( "idShort" | "id" | "assetInformation.assetKind" | "assetInformation.assetType" | "assetInformation.globalAssetId" | "assetInformation." <SpecificAssetIdsClause> | "submodels" ( "[" ( [0-9]* ) "]" ) "." <ReferenceClause> )
<FieldIdentifierSM> ::= "$sm#" ( <SemanticIdClause> | "idShort" | "id" )
<FieldIdentifierSME> ::= "$sme" ( "." <idShortPath> )? "#" ( <SemanticIdClause> | "idShort" | "value" | "valueType" | "language" )
<FieldIdentifierCD> ::= "$cd#" ( "idShort" | "id" ) <ws>
<FieldIdentifierAasDescriptor> ::= "$aasdesc#" ( "idShort" | "id" | "assetKind" | "assetType" | "globalAssetId" | <SpecificAssetIdsClause> | "endpoints" ( "[" ( [0-9]* ) "]" ) "." <EndpointClause> | "submodelDescriptors" ( "[" ( [0-9]* ) "]" ) "." <SmDescriptorClause> )

<FieldIdentifierAAS> ::= "$aas#" <FieldsAAS>
<FieldIdentifierSM> ::= "$sm#" <FieldsSM>
<FieldIdentifierSME> ::= "$sme" ( "." <idShortPath> )? "#" <FieldsSME>
<FieldIdentifierCD> ::= "$cd#" <FieldsCD> <ws>
<FieldIdentifierAasDescriptor> ::= "$aasdesc#" <FieldsAasDescriptor>
<FieldIdentifierSmDescriptor> ::= "$smdesc#" <SmDescriptorClause>

<FieldsAAS> ::= "idShort" | "id" | "assetInformation.assetKind" | "assetInformation.assetType" | "assetInformation.globalAssetId" | "assetInformation." <SpecificAssetIdsClause> | "submodels" ( "[" ( [0-9]* ) "]" ) "." <ReferenceClause>
<FieldsSM> ::= <SemanticIdClause> | "idShort" | "id"
<FieldsSME> ::= <SemanticIdClause> | "idShort" | "value" | "valueType" | "language"
<FieldsCD> ::= "idShort" | "id"
<FieldsAasDescriptor> ::= "idShort" | "id" | "assetKind" | "assetType" | "globalAssetId" | <SpecificAssetIdsClause> | "endpoints" ( "[" ( [0-9]* ) "]" ) "." <EndpointClause> | "submodelDescriptors" ( "[" ( [0-9]* ) "]" ) "." <SmDescriptorClause>
<SmDescriptorClause> ::= ( <SemanticIdClause> | "idShort" | "id" | "endpoints" ( "[" ( [0-9]* ) "]" ) "." <EndpointClause> )
<EndpointClause> ::= "interface" | "protocolinformation.href"

<ReferenceClause> ::= ( "type" | "keys" ( "[" ( [0-9]* ) "]" ) ( ".type" | ".value" ) )
<SemanticIdClause> ::= ( "semanticId" | "semanticId." <ReferenceClause> )
<SpecificAssetIdsClause> ::= ( "specificAssetIds" ( "[" ( [0-9]* ) "]" ) ( ".name" | ".value" | ".externalSubjectId" | ".externalSubjectId." <ReferenceClause> ) )


<FieldIdentifierFragment> ::= <FieldIdentifierAASFragment> | <FieldIdentifierSMFragment> | <FieldIdentifierSMEFragment> | <FieldIdentifierCDFragment> | <FieldIdentifierAasDescriptorFragment> | <FieldIdentifierSmDescriptorFragment>

<FieldIdentifierAASFragment> ::= "$aas#" ( "idShort" | "assetInformation.assetType" | "assetInformation.globalAssetId" | "assetInformation." <SpecificAssetIdsClauseFragment> | "submodels" ( "[" ( [0-9]* ) "]" ) ("." <ReferenceClauseFragment>)? )
<FieldIdentifierSMFragment> ::= "$sm#" ( <SemanticIdClauseFragment> | "idShort" | "id" )
<FieldIdentifierSMEFragment> ::= "$sme" ( "." <idShortPath> )? ( "#" ( <SemanticIdClauseFragment> | "idShort" | "value" | "valueType" | "language" ))?
<FieldIdentifierCDFragment> ::= "$cd#" ( "idShort" ) <ws>
<FieldIdentifierAasDescriptorFragment> ::= "$aasdesc#" ( "idShort" | "description" | "displayName" | "extension" | "administration" | "assetKind" | "assetType" | "globalAssetId" | <SpecificAssetIdsClauseFragment> | <EndpointClauseFragment> | "submodelDescriptors[" ( [0-9]* ) "]" ("." <SmDescriptorClauseFragment>)? )
<FieldIdentifierSmDescriptorFragment> ::= "$smdesc#" <SmDescriptorClauseFragment>

<SpecificAssetIdsClauseFragment> ::= "specificAssetIds" ( "[" ( [0-9]* ) "]" ) (".externalSubjectId" | ".externalSubjectId." <ReferenceClauseFragment>)?
<SmDescriptorClauseFragment> ::= ( <SemanticIdClauseFragment> | "idShort" | <EndpointClauseFragment> )
<EndpointClauseFragment> ::= "endpoints" ( "[" ( [0-9]* ) "]" )

<SemanticIdClauseFragment> ::= "semanticId" | "semanticId." <ReferenceClauseFragment>
<ReferenceClauseFragment> ::= "keys[" ( [0-9]* ) "]"


<idShortPath> ::= ( <idShort> ("[" ( [0-9]* ) "]" )* ( "." <idShortPath> )* )
<idShort> ::= ( ( [a-z] | [A-Z] ) (( [a-z] | [A-Z] | [0-9] | "_" | "-" )* ( [a-z] | [A-Z] | [0-9] | "_" ) )? )

Expand Down
4 changes: 2 additions & 2 deletions documentation/IDTA-01004/modules/ROOT/partials/bnf/objects.bnf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
"REFERABLE" <ws> "$sme" <IdentifierInstanceOrAll> "." <idShortPath>

<FragmentObject> ::=
"FRAGMENT" <ws> "$sme" <IdentifierInstanceOrAll> "." <idShortPath> ( <ws> <StringLiteral> )+
"FRAGMENT" <ws> <FragmentLiteral> <ws>

<DescriptorObject> ::=
"DESCRIPTOR" <ws> ("$aasdesc" | "$smdesc") <IdentifierInstanceOrAll>

Expand Down
36 changes: 34 additions & 2 deletions documentation/IDTA-01004/modules/ROOT/partials/json/aas-queries-and-access-rules-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,14 @@
"type": "string",
"pattern": "^[A-Za-z0-9/\\*\\[\\]\\(\\) _@#\\\\+\\-\\.,:\\$\\^]+$"
},
"FieldIdentifierAAS": {
"FieldIdentifier": {
"type": "string",
"pattern": "^(?:\\$aas#(?:idShort|id|assetInformation\\.assetKind|assetInformation\\.assetType|assetInformation\\.globalAssetId|assetInformation\\.specificAssetIds\\[[0-9]*\\]\\.(?:name|value|externalSubjectId(?:\\.(?:type|keys\\[[0-9]*\\]\\.(?:type|value)))?)|submodels\\[[0-9]*\\]\\.(?:type|keys\\[[0-9]*\\]\\.(?:type|value)))|\\$sm#(?:semanticId(?:\\.(?:type|keys\\[[0-9]*\\]\\.(?:type|value)))?|idShort|id)|\\$sme(?:\\.[A-Za-z](?:[A-Za-z0-9_-]*[A-Za-z0-9_])?(?:\\[[0-9]*\\])*(?:\\.[A-Za-z](?:[A-Za-z0-9_-]*[A-Za-z0-9_])?(?:\\[[0-9]*\\])*)*)?#(?:semanticId(?:\\.(?:type|keys\\[[0-9]*\\]\\.(?:type|value)))?|idShort|value|valueType|language)|\\$cd#(?:idShort|id)|\\$aasdesc#(?:idShort|id|assetKind|assetType|globalAssetId|specificAssetIds\\[[0-9]*\\]\\.(?:name|value|externalSubjectId(?:\\.(?:type|keys\\[[0-9]*\\]\\.(?:type|value)))?)|endpoints\\[[0-9]*\\]\\.(?:interface|protocolinformation\\.href)|submodelDescriptors\\[[0-9]*\\]\\.(?:semanticId(?:\\.(?:type|keys\\[[0-9]*\\]\\.(?:type|value)))?|idShort|id|endpoints\\[[0-9]*\\]\\.(?:interface|protocolinformation\\.href)))|\\$smdesc#(?:semanticId(?:\\.(?:type|keys\\[[0-9]*\\]\\.(?:type|value)))?|idShort|id|endpoints\\[[0-9]*\\]\\.(?:interface|protocolinformation\\.href)))$"
},
"FragmentFieldIdentifier": {
"type": "string",
"pattern": "^(?:\\$aas#(?:idShort|assetInformation\\.assetType|assetInformation\\.globalAssetId|assetInformation\\.specificAssetIds\\[[0-9]*\\](?:\\.externalSubjectId(?:\\.keys\\[[0-9]*\\])?)?|submodels\\[[0-9]*\\](?:\\.keys\\[[0-9]*\\])?)|\\$sm#(?:semanticId(?:\\.keys\\[[0-9]*\\])?|idShort|id)|\\$sme(?:\\.[A-Za-z](?:[A-Za-z0-9_-]*[A-Za-z0-9_])?(?:\\[[0-9]*\\])*(?:\\.[A-Za-z](?:[A-Za-z0-9_-]*[A-Za-z0-9_])?(?:\\[[0-9]*\\])*)*)?(?:#(?:semanticId(?:\\.keys\\[[0-9]*\\])?|idShort|value|valueType|language))?|\\$cd#idShort|\\$aasdesc#(?:idShort|description|displayName|extension|administration|assetKind|assetType|globalAssetId|specificAssetIds\\[[0-9]*\\](?:\\.externalSubjectId(?:\\.keys\\[[0-9]*\\])?)?|endpoints\\[[0-9]*\\]|submodelDescriptors\\[[0-9]*\\](?:\\.(?:semanticId(?:\\.keys\\[[0-9]*\\])?|idShort|endpoints\\[[0-9]*\\]))?)|\\$smdesc#(?:semanticId(?:\\.keys\\[[0-9]*\\])?|idShort|endpoints\\[[0-9]*\\]))$"
},
"hexLiteralPattern": {
"type": "string",
"pattern": "^16#[0-9A-F]+$"
Expand Down Expand Up @@ -653,6 +657,12 @@
"FILTER": {
"$ref": "#/definitions/SecurityQueryFilter",
"additionalProperties": false
},
"FILTERLIST": {

Check warning on line 661 in documentation/IDTA-01004/modules/ROOT/partials/json/aas-queries-and-access-rules-schema.json

View workflow job for this annotation

GitHub Actions / qodana

Typo 

Typo: In word 'FILTERLIST'
Comment thread Fixed

Check warning

Code scanning / QDJVMC

Typo Warning documentation

Typo: In word 'FILTERLIST'
"type": "array",
"items": {
"$ref": "#/definitions/SecurityQueryFilter"
}
}
},
"allOf": [
Expand Down Expand Up @@ -705,7 +715,7 @@
"type": "object",
"properties": {
"FRAGMENT": {
"type": "string"
"$ref": "#/definitions/FragmentFieldIdentifier"
},
"CONDITION": {
"$ref": "#/definitions/logicalExpression"
Expand All @@ -731,6 +741,22 @@
],
"additionalProperties": false
},
"QueryFilter": {
"type": "object",
"properties": {
"$fragment": {
"$ref": "#/definitions/FragmentFieldIdentifier"
},
"$condition": {
"$ref": "#/definitions/logicalExpression"
}
},
"required": [
"$fragment",
"$condition"
],
"additionalProperties": false
},
"Query": {
"type": "object",
"properties": {
Expand All @@ -740,6 +766,12 @@
},
"$condition": {
"$ref": "#/definitions/logicalExpression"
},
"$filters": {
"type": "array",
"items": {
"$ref": "#/definitions/QueryFilter"
}
}
},
"required": [
Expand Down
68 changes: 41 additions & 27 deletions documentation/IDTA-01004/modules/ROOT/partials/json/access-rule-model.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,41 +173,55 @@
"FILTER": {
"$ref": "#/definitions/SecurityQueryFilter",
"additionalProperties": false
}
},
"oneOf": [
{
"required": [
"ACL"
]
},
{
"required": [
"USEACL"
]
"FILTERLIST": {

Check warning on line 177 in documentation/IDTA-01004/modules/ROOT/partials/json/access-rule-model.json

View workflow job for this annotation

GitHub Actions / qodana

Typo 

Typo: In word 'FILTERLIST'
Comment thread Fixed

Check warning

Code scanning / QDJVMC

Typo Warning documentation

Typo: In word 'FILTERLIST'
"type": "array",
"items": {
"$ref": "#/definitions/SecurityQueryFilter"
}
}
],
"oneOf": [
},
"allOf": [
{
"required": [
"OBJECTS"
"oneOf": [
{
"required": [
"ACL"
]
},
{
"required": [
"USEACL"
]
}
]
},
{
"required": [
"USEOBJECTS"
]
}
],
"oneOf": [
{
"required": [
"FORMULA"
"oneOf": [
{
"required": [
"OBJECTS"
]
},
{
"required": [
"USEOBJECTS"
]
}
]
},
{
"required": [
"USEFORMULA"
"oneOf": [
{
"required": [
"FORMULA"
]
},
{
"required": [
"USEFORMULA"
]
}
]
}
],
Expand All @@ -217,7 +231,7 @@
"type": "object",
"properties": {
"FRAGMENT": {
"type": "string"
"$ref": "#/definitions/FragmentFieldIdentifier"
},
"CONDITION": {
"$ref": "#/definitions/logicalExpression"
Expand Down
Loading