Fix Cardinality for Response Payloads of PUTs and PATCH #263

sebbader-sap · 2024-03-19T17:03:05Z

No description provided.

…REST-API.adoc Co-authored-by: Birgit Boss <[email protected]>

…REST-API.adoc Co-authored-by: Michael Jacoby <[email protected]>

…ceSpecification/SSP-002

…min-shell-io/aas-specs-api into SeBa/bugfix-changes-for-3.1.0

… regex

BirgitBoss · 2024-04-08T13:59:20Z

AssetAdministrationShellRepositoryServiceSpecification/V3.0_SSP-001.yaml

-                $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.2#/components/schemas/PathItem'
+                type: array
+                items:
+                  $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.2#/components/schemas/PathItem'


BirgitBoss · 2024-04-08T13:59:29Z

AssetAdministrationShellRepositoryServiceSpecification/V3.0_SSP-002.yaml

-                $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.2#/components/schemas/PathItem'
+                type: array
+                items:
+                  $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.2#/components/schemas/PathItem'


BirgitBoss · 2024-04-08T14:00:44Z

Entire-API-Collection/V3.0.yaml

-                $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.2#/components/schemas/PathItem'
+                type: array
+                items:
+                  $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.2#/components/schemas/PathItem'


BirgitBoss · 2024-04-08T14:03:12Z

Part2-API-Schemas/openapi.yaml

@@ -52,7 +52,7 @@ components:
        type: string
        minLength: 1
        maxLength: 2000
-        pattern: "^[\\x09\\x0A\\x0D\\x20-\\uD7FF\\uE000-\\uFFFD\\U00010000-\\U0010FFFF]*$"
+        pattern: ^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$


this should reflect Constraint AASd-130: an attribute with data type "string" shall consist of these characters only: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u00010000-\u0010FFFF]*$. ? see also admin-shell-io/aas-specs#362

a) removed Category from example since deprecated b) change ConceptDescription to GlobalReference since only external references allowed for semanticId with V3.1

BirgitBoss

Please check version in $ref, should be V3.1?
semanticId of SMT TechnicalData is no IRDI
see also #272 for further change requests
I was not able to review the RegEx
For ServiceDescription: We do not have an enumeration any longer, or an open enumeration. But for this we need an update of Annex Class Table Templates.
ServiceSpecificationProfileEnum: a little bit strange: either list all /3/0 and then /3/1 or always as pairs with the different versions. But I feel some are missing. Or is it because they did not change in V3.1?

BirgitBoss · 2024-04-08T14:03:43Z

Part2-API-Schemas/openapi.yaml

@@ -164,7 +164,7 @@ components:
              type: string
              minLength: 1
              maxLength: 2000
-              pattern: "^[\\x09\\x0A\\x0D\\x20-\\uD7FF\\uE000-\\uFFFD\\U00010000-\\U0010FFFF]*$"
+              pattern: ^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$


see line 55

BirgitBoss · 2024-04-08T14:03:50Z

Part2-API-Schemas/openapi.yaml

@@ -174,15 +174,15 @@ components:
              type: string
              minLength: 1
              maxLength: 2000
-              pattern: "^[\\x09\\x0A\\x0D\\x20-\\uD7FF\\uE000-\\uFFFD\\U00010000-\\U0010FFFF]*$"
+              pattern: ^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$


see line 55

BirgitBoss · 2024-04-08T14:04:00Z

Part2-API-Schemas/openapi.yaml

            idShort: 
              type: string
              maxLength: 128
            id: 
              type: string
              maxLength: 2000
              minLength: 1
-              pattern: "^[\\x09\\x0A\\x0D\\x20-\\uD7FF\\uE000-\\uFFFD\\U00010000-\\U0010FFFF]*$"
+              pattern: ^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$


see line 55

BirgitBoss · 2024-04-08T14:04:08Z

Part2-API-Schemas/openapi.yaml

@@ -306,7 +306,7 @@ components:
          type: string
          minLength: 1
          maxLength: 2000
-          pattern: "^[\\x09\\x0A\\x0D\\x20-\\uD7FF\\uE000-\\uFFFD\\U00010000-\\U0010FFFF]*$"
+          pattern: ^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$


see line 55

BirgitBoss · 2024-04-08T14:04:13Z

Part2-API-Schemas/openapi.yaml

@@ -565,7 +565,7 @@ components:
        aasIds: 
          items: 
            type: string
-            pattern: "^[\\x09\\x0A\\x0D\\x20-\\uD7FF\\uE000-\\uFFFD\\U00010000-\\U0010FFFF]*$"
+            pattern: ^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$


see line 55

BirgitBoss · 2024-04-08T14:05:42Z

Part2-API-Schemas/openapi.yaml

@@ -740,7 +740,7 @@ components:
          type: string
          minLength: 1
          maxLength: 2000
-          pattern: "^[\\x09\\x0A\\x0D\\x20-\\uD7FF\\uE000-\\uFFFD\\U00010000-\\U0010FFFF]*$"
+          pattern: ^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$


see line 55

BirgitBoss · 2024-04-08T14:07:31Z

Part2-API-Schemas/openapi.yaml

    ValueOnly: 
-      description: "The ValueOnly serialization of submodel elements (patternProperties and propertyNames will be supported propably with OpenApi 3.1). The full description of the generic JSON validation schema for the ValueOnly-serialization can be found in chapter 11.4.3 in Details of the Asset Administration Shell Part 2.\n"
+      description: "The ValueOnly serialization (patternProperties and propertyNames will be supported probably with OpenApi 3.1). For the full description of the generic JSON validation schema see the ValueOnly-Serialization as defined in the 'Specification of the Asset Administration Shell - Part 2'."


Suggested change

description: "The ValueOnly serialization (patternProperties and propertyNames will be supported probably with OpenApi 3.1). For the full description of the generic JSON validation schema see the ValueOnly-Serialization as defined in the 'Specification of the Asset Administration Shell - Part 2'."

description: "The ValueOnly serialization (patternProperties and propertyNames will be supported probably with OpenApi 3.1). For the full description of the generic JSON validation schema see the ValueOnly-Serialization as defined in the 'Specification of the Asset Administration Shell - Part 1' (IDTA-01001)."

BirgitBoss · 2024-04-08T14:11:34Z

...entation/IDTA-01002-3/modules/ROOT/pages/Annex/IDTA-01002_SerializationModifierExamples.adoc

@@ -118,52 +119,15 @@ If applied to the Submodel:
        "value": "0173-1#01-AFZ615#016"


Suggested change

"value": "0173-1#01-AFZ615#016"

"value": "0173-1#01-AHF578#001"

I did not check the older IRDI, but this one is for HandoverDocumentation, see https://github.com/admin-shell-io/submodel-templates/blob/main/published/Handover%20Documentation/1/2/IDTA%2002004-1-2_Submodel_Handover%20Documentation.pdf

idShort should be changed to "HandoverDocumentation"

BirgitBoss · 2024-04-08T14:15:33Z

...entation/IDTA-01002-3/modules/ROOT/pages/Annex/IDTA-01002_SerializationModifierExamples.adoc

-  "semanticId": {
-    "keys": [ {
-        "type": "GlobalReference",
-        "value": "0173-1#01-AFZ615#016"


For Technical Data it would be https://admin-shell.io/ZVEI/TechnicalData/Submodel/1/2
or change to Handover Docmentation, there it is an IRDI, see line 119

BirgitBoss · 2024-04-08T14:32:19Z

documentation/IDTA-01002-3/modules/ROOT/pages/IDTA-01002_HTTP-REST-API.adoc

@@ -279,7 +281,12 @@ h|Operation Name h|HTTP Verb h|REST-Path h|Comment (e.g. optional query paramete
 |GetAssetAdministrationShell |GET |/aas |content-suffix: $reference
 |PutAssetAdministrationShell |PUT | |
 |GetAllSubmodelReferences |GET |/aas/submodel-refs |Pagination
-|PostSubmodelReference |POST |/aas/submodel-refs |
+|PostSubmodelReference |POST |/aas/submodel-refs a| Location header of the response contains the value ‘<baseUrl>/aas/submodel-ref/{submodelIdentifier}’ 


‘/aas/submodel-refs/{submodelIdentifier}’ Plural

Remove Category, semanticId only ExternalReference

sebbader-sap and others added 16 commits March 4, 2024 16:52

remove "submodelElements" from SubmodelValue

44d3163

add V3.0.2 fixes

cb2c72f

add bugfixes to the get and patch example table

a72897f

Update documentation/IDTA-01002-3/modules/ROOT/pages/IDTA-01002_HTTP-…

672ca75

…REST-API.adoc Co-authored-by: Birgit Boss <[email protected]>

Update documentation/IDTA-01002-3/modules/ROOT/pages/IDTA-01002_HTTP-…

859cf57

…REST-API.adoc Co-authored-by: Michael Jacoby <[email protected]>

fix description for https://admin-shell.io/aas/API/3/1/DiscoveryServi…

2459eb8

…ceSpecification/SSP-002

Merge branch 'SeBa/bugfix-changes-for-3.1.0' of https://github.com/ad…

cfb95ab

…min-shell-io/aas-specs-api into SeBa/bugfix-changes-for-3.1.0

fix the regex pattern for part 2 classes according to the JSON schema…

17290ae

… regex

fix metadata example

b4cfd83

fix metadata example

f09d62d

extend/fix examples for serialisation modifiers

8cba655

remove V3.1 discovery service profile from this branch

8c49f99

add pathitem fix

0bfd541

Fix sentence for the ValueOnly definition

3ae4874

fix constraint for metadata + level

1979588

make payload optional for put and patch

ccedd37

sebbader-sap added this to the 3.1 milestone Mar 19, 2024

BirgitBoss reviewed Apr 8, 2024

View reviewed changes

Category deprecated, semanticId only ExternalReference

390aef8

a) removed Category from example since deprecated b) change ConceptDescription to GlobalReference since only external references allowed for semanticId with V3.1

BirgitBoss requested changes Apr 8, 2024

View reviewed changes

Merge pull request #272 from admin-shell-io/BirgitBoss-patch-1

56977e3

Remove Category, semanticId only ExternalReference

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix Cardinality for Response Payloads of PUTs and PATCH #263

Fix Cardinality for Response Payloads of PUTs and PATCH #263

sebbader-sap commented Mar 19, 2024

BirgitBoss Apr 8, 2024

BirgitBoss Apr 8, 2024

BirgitBoss Apr 8, 2024

BirgitBoss Apr 8, 2024 •

edited

Loading

BirgitBoss left a comment

BirgitBoss Apr 8, 2024

BirgitBoss Apr 8, 2024

BirgitBoss Apr 8, 2024

BirgitBoss Apr 8, 2024

BirgitBoss Apr 8, 2024

BirgitBoss Apr 8, 2024

BirgitBoss Apr 8, 2024

BirgitBoss Apr 8, 2024

BirgitBoss Apr 8, 2024

BirgitBoss Apr 8, 2024

BirgitBoss Apr 8, 2024

BirgitBoss Apr 8, 2024

	description: "The ValueOnly serialization (patternProperties and propertyNames will be supported probably with OpenApi 3.1). For the full description of the generic JSON validation schema see the ValueOnly-Serialization as defined in the 'Specification of the Asset Administration Shell - Part 2'."
	description: "The ValueOnly serialization (patternProperties and propertyNames will be supported probably with OpenApi 3.1). For the full description of the generic JSON validation schema see the ValueOnly-Serialization as defined in the 'Specification of the Asset Administration Shell - Part 1' (IDTA-01001)."

		@@ -118,52 +119,15 @@ If applied to the Submodel:
		"value": "0173-1#01-AFZ615#016"

	"value": "0173-1#01-AFZ615#016"
	"value": "0173-1#01-AHF578#001"

Fix Cardinality for Response Payloads of PUTs and PATCH #263

Are you sure you want to change the base?

Fix Cardinality for Response Payloads of PUTs and PATCH #263

Conversation

sebbader-sap commented Mar 19, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BirgitBoss Apr 8, 2024 • edited Loading

Choose a reason for hiding this comment

BirgitBoss left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BirgitBoss Apr 8, 2024 •

edited

Loading