Added $filters to AAS QL & enhanced Fragment Fieldidentifiers

Part2-API-Schemas/openapi.yaml

@@ -629,6 +629,10 @@ components:
       type: string
       pattern: >-
         ^((?:\$aas#(?:idShort|id|assetInformation\.assetKind|assetInformation\.assetType|assetInformation\.globalAssetId|assetInformation\.(?:specificAssetIds(\[[0-9]*\])(?:\.(?:name|value|externalSubjectId(?:\.type|\.keys\[\d*\](?:\.(?:type|value))?)?)?)|submodels\.(?:type|keys\[\d*\](?:\.(?:type|value))?))|submodels\.(type|keys\[\d*\](?:\.(type|value))?)))|(?:\$sm#(?:semanticId(?:\.type|\.keys\[\d*\](?:\.(type|value))?)?|idShort|id))|(?:\$sme(?:\.[a-zA-Z][a-zA-Z0-9_]*(\[[0-9]*\])?(?:\.[a-zA-Z][a-zA-Z0-9_]*(\[[0-9]*\])?)*)?#(?:semanticId(?:\.type|\.keys\[\d*\](?:\.(type|value))?)?|idShort|value|valueType|language))|(?:\$cd#(?:idShort|id))|(?:\$aasdesc#(?:idShort|id|assetKind|assetType|globalAssetId|specificAssetIds(\[[0-9]*\])?(?:\.(name|value|externalSubjectId(?:\.type|\.keys\[\d*\](?:\.(type|value))?)?)?)|endpoints(\[[0-9]*\])\.(interface|protocolinformation\.href)|submodelDescriptors(\[[0-9]*\])\.(semanticId(?:\.type|\.keys\[\d*\](?:\.(type|value))?)?|idShort|id|endpoints(\[[0-9]*\])\.(interface|protocolinformation\.href))))|(?:\$smdesc#(?:semanticId(?:\.type|\.keys\[\d*\](?:\.(type|value))?)?|idShort|id|endpoints(\[[0-9]*\])\.(interface|protocolinformation\.href))))$
+    fragmentStringPattern:
+      type: string
+      pattern: >-
+        ^(?:\$aas#(?:idShort|assetInformation\.assetType|assetInformation\.globalAssetId|assetInformation\.specificAssetIds\[\d*\](?:\.externalSubjectId(?:\.keys\[\d*\])?)?|submodels|submodels\.keys\[\d*\])|(?:\$sm#(?:semanticId(?:\.keys\[\d*\])?|idShort|id))|(?:\$sme(?:\.(?:[a-zA-Z](?:[a-zA-Z0-9_-]*[a-zA-Z0-9_])?(?:\[\d*\])*)*)?(?:#(?:semanticId(?:\.keys\[\d*\])?|idShort|value|valueType|language))?)|(?:\$cd#idShort)|(?:\$aasdesc#(?:idShort|assetKind|assetType|globalAssetId|specificAssetIds\[\d*\](?:\.externalSubjectId(?:\.keys\[\d*\])?)?|endpoints\[\d*\]|submodelDescriptors\[\d*\]|submodelDescriptors\[\d*\]\.(?:semanticId(?:\.keys\[\d*\])?|idShort|endpoints\[\d*\])))|(?:\$smdesc#(?:semanticId(?:\.keys\[\d*\])?|idShort|endpoints\[\d*\])))$
     MultiLanguagePropertyMetadata: 
       allOf: 
         - $ref: "#/components/schemas/SubmodelElementAttributes"
@@ -776,6 +780,19 @@ components:
       required: 
         - href
       type: object
+    QueryFilter:
+      type: object
+      properties:
+        $fragment:
+          description: Field identifier fragment the filter applies to (FieldIdentifierFragment in the BNF).
+          $ref: '#/components/schemas/fragmentStringPattern'
+        $condition:
+          description: Logical expression to be applied for this field identifier fragment.
+          $ref: '#/components/schemas/logicalExpression'
+      required:
+        - $fragment
+        - $condition
+      additionalProperties: false
     Query:
       type: object
       properties:
@@ -784,6 +801,13 @@ components:
           pattern: ^id$
         $condition:
           $ref: '#/components/schemas/logicalExpression'
+        $filters:
+          description: >-
+            Additional filters scoped to specific field identifier fragments, corresponding to
+            repeated "$filter <FieldIdentifierFragment> <logicalExpression>" clauses in the BNF.
+          type: array
+          items:
+            $ref: '#/components/schemas/QueryFilter'
       required:
         - $condition
       additionalProperties: false

documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc

@@ -14,7 +14,7 @@ Note: Changes in Metamodel (IDTA-01001) will not be listed here, although they h
 
 Major Changes:
 
-* ...
+* new: Enhanced the FieldIdentifier Fragment Definition from just plain string to a BNF specification. Extended the query language and security with field-based filters (`$filters` & `FILTERS` clauses) using field identifier fragments, and aligned the OpenAPI schemas and JSON Schema for queries and security rules accordingly. Addition does not introduce breaking changes because it only adds new optional field (https://github.com/admin-shell-io/aas-specs-api/issues/517[#517])
 
 
 Minor Changes:

documentation/IDTA-01002-3/modules/ROOT/pages/http-rest-api/test/query/test1.json

@@ -1,26 +1,15 @@
 {
-    "$schema": "../../query-json-schema.json",
-    "select": "id",
-    "filter": {
-        "$and":[
-            {
-                "$eq": [
-                    {
-                        "strModel": "$sm.semanticId.keys.value"
-                    },
-                    {
-                        "strVal": "https://example.org/value"
-                    }
-                ]
-            },
-            {}
-        ]
-    },
-    "option": {
-        "sort": {
-            "id": "asc"
-        },
-        "limit": 10,
-        "offset": 0
+    "Query": {
+        "$select": "id",
+        "$condition": {
+            "$eq": [
+                {
+                    "$field": "$sm#semanticId.keys[].value"
+                },
+                {
+                    "$strVal": "https://example.org/value"
+                }
+            ]
+        }
     }
 }