Skip to content

Commit e0952a5

Browse files
sebbader-sapsebbader-sap
authored
add OperationRequestValueOnly and OperationRequestAsyncValueOnly to make "clientTimeoutDuration" mandatory for async operation invocations only (#564)
1 parent bc04c52 commit e0952a5

File tree

8 files changed

+29
-20
lines changed

8 files changed

+29
-20
lines changed

‎AssetAdministrationShellRepositoryServiceSpecification/V3.1_SSP-001.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1609,7 +1609,7 @@ paths:
16091609
content:
16101610
application/json:
16111611
schema:
1612-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequest'
1612+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequestAsync'
16131613
required: true
16141614
responses:
16151615
'202':
@@ -1643,7 +1643,7 @@ paths:
16431643
content:
16441644
application/json:
16451645
schema:
1646-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequestValueOnly'
1646+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequestAsyncValueOnly'
16471647
required: true
16481648
responses:
16491649
'202':

‎AssetAdministrationShellRepositoryServiceSpecification/V3.2_SSP-001.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1609,7 +1609,7 @@ paths:
16091609
content:
16101610
application/json:
16111611
schema:
1612-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequest'
1612+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequestAsync'
16131613
required: true
16141614
responses:
16151615
'202':
@@ -1643,7 +1643,7 @@ paths:
16431643
content:
16441644
application/json:
16451645
schema:
1646-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequestValueOnly'
1646+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequestAsyncValueOnly'
16471647
required: true
16481648
responses:
16491649
'202':

‎AssetAdministrationShellServiceSpecification/V3.1_SSP-001.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1425,7 +1425,7 @@ paths:
14251425
content:
14261426
application/json:
14271427
schema:
1428-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequest'
1428+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequestAsync'
14291429
required: true
14301430
responses:
14311431
'202':
@@ -1458,7 +1458,7 @@ paths:
14581458
content:
14591459
application/json:
14601460
schema:
1461-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequestValueOnly'
1461+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequestAsyncValueOnly'
14621462
required: true
14631463
responses:
14641464
'202':

‎Entire-API-Collection/V3.1.yaml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1444,7 +1444,7 @@ paths:
14441444
content:
14451445
application/json:
14461446
schema:
1447-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequest'
1447+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequestAsync'
14481448
required: true
14491449
responses:
14501450
'202':
@@ -1477,7 +1477,7 @@ paths:
14771477
content:
14781478
application/json:
14791479
schema:
1480-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequestValueOnly'
1480+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequestAsyncValueOnly'
14811481
required: true
14821482
responses:
14831483
'202':
@@ -2689,7 +2689,7 @@ paths:
26892689
content:
26902690
application/json:
26912691
schema:
2692-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequest'
2692+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequestAsync'
26932693
required: true
26942694
responses:
26952695
'202':
@@ -2727,7 +2727,7 @@ paths:
27272727
content:
27282728
application/json:
27292729
schema:
2730-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequestValueOnly'
2730+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequestAsyncValueOnly'
27312731
required: true
27322732
responses:
27332733
'202':
@@ -4437,7 +4437,7 @@ paths:
44374437
content:
44384438
application/json:
44394439
schema:
4440-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequest'
4440+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequestAsync'
44414441
required: true
44424442
responses:
44434443
'202':
@@ -4471,7 +4471,7 @@ paths:
44714471
content:
44724472
application/json:
44734473
schema:
4474-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequestValueOnly'
4474+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequestAsyncValueOnly'
44754475
required: true
44764476
responses:
44774477
'202':
@@ -5987,7 +5987,7 @@ paths:
59875987
content:
59885988
application/json:
59895989
schema:
5990-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequest'
5990+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequestAsync'
59915991
required: true
59925992
responses:
59935993
'202':
@@ -6027,7 +6027,7 @@ paths:
60276027
content:
60286028
application/json:
60296029
schema:
6030-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequestValueOnly'
6030+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequestAsyncValueOnly'
60316031
required: true
60326032
responses:
60336033
'202':

‎Part2-API-Schemas/openapi.yaml‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -660,6 +660,11 @@ components:
660660
type: string
661661
pattern: "^(-?)P(?=.)((\\d+)Y)?((\\d+)M)?((\\d+)D)?(T(?=.)((\\d+)H)?((\\d+)M)?(\\d*(\\.\\d+)?S)?)?$"
662662
type: object
663+
OperationRequestAsync:
664+
allOf:
665+
- $ref: "#/components/schemas/OperationRequest"
666+
- required:
667+
- clientTimeoutDuration
663668
OperationRequestValueOnly:
664669
properties:
665670
inoutputArguments:
@@ -670,8 +675,11 @@ components:
670675
type: string
671676
pattern: "^(-?)P(?=.)((\\d+)Y)?((\\d+)M)?((\\d+)D)?(T(?=.)((\\d+)H)?((\\d+)M)?(\\d*(\\.\\d+)?S)?)?$"
672677
type: object
673-
required:
674-
- clientTimeoutDuration
678+
OperationRequestAsyncValueOnly:
679+
allOf:
680+
- $ref: "#/components/schemas/OperationRequestValueOnly"
681+
- required:
682+
- clientTimeoutDuration
675683
OperationResult:
676684
allOf:
677685
- $ref: '#/components/schemas/BaseOperationResult'

‎SubmodelRepositoryServiceSpecification/V3.1_SSP-001.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1381,7 +1381,7 @@ paths:
13811381
content:
13821382
application/json:
13831383
schema:
1384-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequest'
1384+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequestAsync'
13851385
required: true
13861386
responses:
13871387
'202':
@@ -1421,7 +1421,7 @@ paths:
14211421
content:
14221422
application/json:
14231423
schema:
1424-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequestValueOnly'
1424+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequestAsyncValueOnly'
14251425
required: true
14261426
responses:
14271427
'202':

‎SubmodelServiceSpecification/V3.1_SSP-001.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1102,7 +1102,7 @@ paths:
11021102
content:
11031103
application/json:
11041104
schema:
1105-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequest'
1105+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequestAsync'
11061106
required: true
11071107
responses:
11081108
'202':
@@ -1140,7 +1140,7 @@ paths:
11401140
content:
11411141
application/json:
11421142
schema:
1143-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequestValueOnly'
1143+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.2#/components/schemas/OperationRequestAsyncValueOnly'
11441144
required: true
11451145
responses:
11461146
'202':

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Major Changes:
2020
Minor Changes:
2121

2222
* Added the `ServerNotImplemented` status code to the xref:specification/interfaces-payload.adoc#table-status-codes[Status Codes]. Note that the HTTP API mentioned this status code already, therefore, no change in OpenAPI or other related files. (https://github.com/admin-shell-io/aas-specs-api/issues/499[#499])
23+
* Remove the requirement to have "clientTimeoutDuration" for asynchronous operation invocations in the OpenAPI files. This is a change in the OpenAPI files only, as the "clientTimeoutDuration" parameter was already optional in the definition of the OperationRequestAsync class in the OpenAPI schema. (https://github.com/admin-shell-io/aas-specs-api/issues/563[#563])
2324

2425

2526

0 commit comments

Comments
 (0)