Skip to content

Commit a6963b4

Browse files
sebbader-sapBirgitBossaorzelskiGHMartin187187
authored
Signing API based on JWS (#527)
* Create signatures.adoc * Update signatures.adoc * Update signatures.adoc * Signature description * Add JWS * Add operations for JWS signatures * Add JWS signature profiles * Add mapping of JWS signature * Add signature profiles * add changelog for PR Signing (#561) * Add V3.1.2 Bugfixes into V3.2.0 (#541) * fix ServiceSpecificationProfileEnum values for 3.0 and 3.1 * remove TREE (#539) * remove v3.2 profile uris --------- Co-authored-by: Martin Stemmer <52048213+Martin187187@users.noreply.github.com> * remove GetAllAssetAdministrationShellDescriptorsByAssetType from openapi (#530) * added changelog for new signing operations and profiles * undo changes to the profiles table * fix typo --------- Co-authored-by: sebbader-sap <107036549+sebbader-sap@users.noreply.github.com> Co-authored-by: Martin Stemmer <52048213+Martin187187@users.noreply.github.com> * adding signature profiles as openapi yaml * editorial fix * editorial change * fix typo --------- Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> Co-authored-by: aorzelskiGH <48956800+aorzelskiGH@users.noreply.github.com> Co-authored-by: Martin Stemmer <52048213+Martin187187@users.noreply.github.com>
1 parent fd3fff8 commit a6963b4

File tree

11 files changed

+634
-21
lines changed

11 files changed

+634
-21
lines changed

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

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
openapi: 3.0.3
2+
info:
3+
title: DotAAS Part 2 | HTTP/REST | Asset Administration Shell Repository Service Specification
4+
description: >-
5+
The Signature Profile of the Asset Administration Shell Repository Service Specification as part of the [Specification of the Asset Administration Shell: Part 2](https://industrialdigitaltwin.org/en/content-hub/aasspecifications).
6+
7+
Copyright: Industrial Digital Twin Association (IDTA) 2026
8+
contact:
9+
name: Industrial Digital Twin Association (IDTA)
10+
email: info@idtwin.org
11+
license:
12+
name: CC BY 4.0
13+
url: https://creativecommons.org/licenses/by/4.0/
14+
version: V3.2.0_SSP-004
15+
x-profile-identifier: https://admin-shell.io/aas/API/3/2/AssetAdministrationShellRepositoryServiceSpecification/SSP-004
16+
servers:
17+
- url: 'https://admin-shell.io/api/v3/'
18+
- url: 'https://example.com/'
19+
paths:
20+
21+
/shells/{aasIdentifier}/$signed:
22+
parameters:
23+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/AssetAdministrationShellIdentifier'
24+
get:
25+
tags:
26+
- Asset Administration Shell Repository API
27+
summary: Returns a specific Asset Administration Shell as a JWS string
28+
operationId: GetAssetAdministrationShellByIdSigned
29+
x-semanticIds:
30+
- https://admin-shell.io/aas/API/GetAssetAdministrationShellByIdSigned/3/2
31+
responses:
32+
'200':
33+
description: Requested Asset Administration Shell as a JWS string.
34+
content:
35+
text/plain:
36+
schema:
37+
type: string
38+
format: jwt
39+
description: A JWS string containing the requested Asset Administration Shell
40+
'400':
41+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/bad-request'
42+
'401':
43+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/unauthorized'
44+
'403':
45+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/forbidden'
46+
'404':
47+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/not-found'
48+
'500':
49+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/internal-server-error'
50+
default:
51+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/default'
52+
53+
/description:
54+
get:
55+
tags:
56+
- Description API
57+
summary: Returns the self-describing information of a network resource (ServiceDescription)
58+
operationId: GetSelfDescription
59+
x-semanticIds:
60+
- https://admin-shell.io/aas/API/GetSelfDescription/3/2
61+
responses:
62+
'200':
63+
description: Requested Description
64+
content:
65+
application/json:
66+
schema:
67+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/schemas/ServiceDescription'
68+
'401':
69+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/unauthorized'
70+
'403':
71+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/forbidden'

‎ConceptDescriptionRepositoryServiceSpecification/V3.2_SSP-003.yaml‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
openapi: 3.0.3
2+
info:
3+
title: DotAAS Part 2 | HTTP/REST | Concept Description Repository Service Specification
4+
description: >-
5+
The Signature Profile of the ConceptDescription Repository Service Specification as part of [Specification of the Asset Administration Shell: Part 2](https://industrialdigitaltwin.org/en/content-hub/aasspecifications).
6+
7+
Copyright: Industrial Digital Twin Association (IDTA) March 2026
8+
contact:
9+
name: Industrial Digital Twin Association (IDTA)
10+
email: info@idtwin.org
11+
license:
12+
name: CC BY 4.0
13+
url: https://creativecommons.org/licenses/by/4.0/
14+
version: V3.2.0_SSP-003
15+
x-profile-identifier: https://admin-shell.io/aas/API/3/2/ConceptDescriptionRepositoryServiceSpecification/SSP-003
16+
termsOfService: https://github.com/admin-shell-io/aas-specs-metamodel
17+
servers:
18+
- url: 'https://admin-shell.io/api/v3/'
19+
- url: 'https://example.com/'
20+
paths:
21+
/concept-descriptions/{cdIdentifier}/$signed:
22+
get:
23+
tags:
24+
- Concept Description Repository API
25+
summary: Returns a specific Concept Description as a JWS string.
26+
operationId: GetConceptDescriptionByIdSigned
27+
x-semanticIds:
28+
- https://admin-shell.io/aas/API/GetConceptDescriptionByIdSigned/3/2
29+
parameters:
30+
- name: cdIdentifier
31+
in: path
32+
description: The Concept Description’s unique id (UTF8-BASE64-URL-encoded)
33+
required: true
34+
style: simple
35+
explode: true
36+
schema:
37+
type: string
38+
responses:
39+
'200':
40+
description: Requested Concept Description as a JWS string.
41+
content:
42+
text/plain:
43+
schema:
44+
type: string
45+
format: jwt
46+
description: A JWS string containing the requested Concept Description.
47+
'400':
48+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/bad-request'
49+
'403':
50+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/forbidden'
51+
'404':
52+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/not-found'
53+
'500':
54+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/internal-server-error'
55+
default:
56+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/default'
57+
58+
/description:
59+
get:
60+
tags:
61+
- Description API
62+
summary: Returns the self-describing information of a network resource (ServiceDescription)
63+
operationId: GetSelfDescription
64+
x-semanticIds:
65+
- https://admin-shell.io/aas/API/GetSelfDescription/3/2
66+
responses:
67+
'200':
68+
description: Requested Description
69+
content:
70+
application/json:
71+
schema:
72+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/schemas/ServiceDescription'
73+
'403':
74+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/forbidden'

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

Lines changed: 99 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3070,6 +3070,37 @@ paths:
30703070
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/internal-server-error'
30713071
default:
30723072
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/default'
3073+
/shells/{aasIdentifier}/$signed:
3074+
parameters:
3075+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/AssetAdministrationShellIdentifier'
3076+
get:
3077+
tags:
3078+
- Asset Administration Shell Repository API
3079+
summary: Returns a specific Asset Administration Shell as a JWS string
3080+
operationId: GetAssetAdministrationShellByIdSigned
3081+
x-semanticIds:
3082+
- https://admin-shell.io/aas/API/GetAssetAdministrationShellByIdSigned/3/2
3083+
responses:
3084+
'200':
3085+
description: Requested Asset Administration Shell as a JWS string.
3086+
content:
3087+
text/plain:
3088+
schema:
3089+
type: string
3090+
format: jwt
3091+
description: A JWS string containing the requested Asset Administration Shell
3092+
'400':
3093+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/bad-request'
3094+
'401':
3095+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/unauthorized'
3096+
'403':
3097+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/forbidden'
3098+
'404':
3099+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/not-found'
3100+
'500':
3101+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/internal-server-error'
3102+
default:
3103+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/default'
30733104
/shells/{aasIdentifier}/asset-information:
30743105
parameters:
30753106
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/AssetAdministrationShellIdentifier'
@@ -5141,6 +5172,37 @@ paths:
51415172
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/internal-server-error'
51425173
default:
51435174
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/default'
5175+
/submodels/{submodelIdentifier}/$signed:
5176+
parameters:
5177+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/SubmodelIdentifier'
5178+
get:
5179+
tags:
5180+
- Submodel Repository API
5181+
summary: Returns a specific Submodel as a JWS string
5182+
operationId: GetSubmodelByIdSigned
5183+
x-semanticIds:
5184+
- https://admin-shell.io/aas/API/GetSubmodelByIdSigned/3/2
5185+
responses:
5186+
'200':
5187+
description: Requested Submodel as a JWS string.
5188+
content:
5189+
text/plain:
5190+
schema:
5191+
type: string
5192+
format: jwt
5193+
description: A JWS string containing the requested Submodel
5194+
'400':
5195+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/bad-request'
5196+
'401':
5197+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/unauthorized'
5198+
'403':
5199+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/forbidden'
5200+
'404':
5201+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/not-found'
5202+
'500':
5203+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/internal-server-error'
5204+
default:
5205+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/default'
51445206
/submodels/{submodelIdentifier}/$path:
51455207
parameters:
51465208
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/SubmodelIdentifier'
@@ -6373,7 +6435,42 @@ paths:
63736435
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/internal-server-error'
63746436
default:
63756437
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/default'
6376-
6438+
/concept-descriptions/{cdIdentifier}/$signed:
6439+
get:
6440+
tags:
6441+
- Concept Description Repository API
6442+
summary: Returns a specific Concept Description as a JWS string.
6443+
operationId: GetConceptDescriptionByIdSigned
6444+
x-semanticIds:
6445+
- https://admin-shell.io/aas/API/GetConceptDescriptionByIdSigned/3/2
6446+
parameters:
6447+
- name: cdIdentifier
6448+
in: path
6449+
description: The Concept Description’s unique id (UTF8-BASE64-URL-encoded)
6450+
required: true
6451+
style: simple
6452+
explode: true
6453+
schema:
6454+
type: string
6455+
responses:
6456+
'200':
6457+
description: Requested Concept Description as a JWS string.
6458+
content:
6459+
text/plain:
6460+
schema:
6461+
type: string
6462+
format: jwt
6463+
description: A JWS string containing the requested Concept Description.
6464+
'400':
6465+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/bad-request'
6466+
'403':
6467+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/forbidden'
6468+
'404':
6469+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/not-found'
6470+
'500':
6471+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/internal-server-error'
6472+
default:
6473+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/responses/default'
63776474

63786475
/query/concept-descriptions:
63796476
post:
@@ -6418,8 +6515,7 @@ paths:
64186515
summary: Returns all Asset Administration Shell Descriptors
64196516
operationId: GetAllAssetAdministrationShellDescriptors
64206517
x-semanticIds:
6421-
- https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptors/3/1
6422-
- https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptorsByAssetType/3/1
6518+
- https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptors/3/2
64236519
parameters:
64246520
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Limit'
64256521
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.2.0#/components/parameters/Cursor'

0 commit comments

Comments
 (0)