Skip to content

Commit 98f3c13

Browse files
sebbader-sapsebbader-sap
committed
add SubmodelRegistryServiceSpecification profiles
1 parent 0e25cee commit 98f3c13

File tree

2 files changed

+302
-0
lines changed

2 files changed

+302
-0
lines changed

‎SubmodelRegistryServiceSpecification/V3.0_SSP-001.yaml‎

Lines changed: 190 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
1+
openapi: 3.0.3
2+
info:
3+
title: DotAAS Part 2 | HTTP/REST | Submodel Registry Service Specification
4+
description: >-
5+
The Full Profile of the Submodel Registry Service Specification as part of the [Specification of the Asset Administration Shell: Part 2](http://industrialdigitaltwin.org/en/content-hub).
6+
7+
Publisher: Industrial Digital Twin Association (IDTA) April 2023
8+
contact:
9+
name: Industrial Digital Twin Association (IDTA)
10+
email: [email protected]
11+
license:
12+
name: CC BY 4.0
13+
url: https://creativecommons.org/licenses/by/4.0/
14+
version: V3.0.1_SSP-001
15+
servers:
16+
- url: '{protocol}://{host_name}:{port}/api/{version_prefix}'
17+
variables:
18+
protocol:
19+
description: 'Allows access through http and https (recommended)'
20+
enum:
21+
- 'http'
22+
- 'https'
23+
default: 'https'
24+
host_name:
25+
default: admin-shell.io
26+
description: 'Hostname of server hosting the api'
27+
port:
28+
enum:
29+
- '80'
30+
- '443'
31+
default: '443'
32+
description: '80 is default for http, 443 for https'
33+
version_prefix:
34+
enum:
35+
- 'v3.0'
36+
default: v3.0
37+
paths:
38+
/submodel-descriptors:
39+
get:
40+
tags:
41+
- Submodel Registry API
42+
summary: Returns all Submodel Descriptors
43+
operationId: GetAllSubmodelDescriptors
44+
x-semanticIds:
45+
- https://admin-shell.io/aas/API/GetAllSubmodelDescriptors/3/0
46+
parameters:
47+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/parameters/Limit'
48+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/parameters/Cursor'
49+
responses:
50+
'200':
51+
description: Requested Submodel Descriptors
52+
content:
53+
application/json:
54+
schema:
55+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/schemas/GetSubmodelDescriptorsResult'
56+
'400':
57+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/bad-request'
58+
'403':
59+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/forbidden'
60+
'404':
61+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/not-found'
62+
'500':
63+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/internal-server-error'
64+
default:
65+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/default'
66+
post:
67+
tags:
68+
- Submodel Registry API
69+
summary: Creates a new Submodel Descriptor, i.e. registers a submodel
70+
operationId: PostSubmodelDescriptor
71+
x-semanticIds:
72+
- https://admin-shell.io/aas/API/PostSubmodelDescriptor/3/0
73+
requestBody:
74+
description: Submodel Descriptor object
75+
content:
76+
application/json:
77+
schema:
78+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/schemas/SubmodelDescriptor'
79+
required: true
80+
responses:
81+
'201':
82+
description: Submodel Descriptor created successfully
83+
headers:
84+
Location:
85+
description: URL of the newly created resource
86+
schema:
87+
type: string
88+
content:
89+
application/json:
90+
schema:
91+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/schemas/SubmodelDescriptor'
92+
'400':
93+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/bad-request'
94+
'403':
95+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/forbidden'
96+
'409':
97+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/conflict'
98+
default:
99+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/default'
100+
/submodel-descriptors/{submodelIdentifier}:
101+
parameters:
102+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/parameters/SubmodelIdentifier'
103+
get:
104+
tags:
105+
- Submodel Registry API
106+
summary: Returns a specific Submodel Descriptor
107+
operationId: GetSubmodelDescriptorById
108+
x-semanticIds:
109+
- https://admin-shell.io/aas/API/GetSubmodelDescriptorById/3/0
110+
responses:
111+
'200':
112+
description: Requested Submodel Descriptor
113+
content:
114+
application/json:
115+
schema:
116+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/schemas/SubmodelDescriptor'
117+
'400':
118+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/bad-request'
119+
'403':
120+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/forbidden'
121+
'404':
122+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/not-found'
123+
'500':
124+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/internal-server-error'
125+
default:
126+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/default'
127+
put:
128+
tags:
129+
- Submodel Registry API
130+
summary: Updates an existing Submodel Descriptor
131+
operationId: PutSubmodelDescriptorById
132+
x-semanticIds:
133+
- https://admin-shell.io/aas/API/PutSubmodelDescriptorById/3/0
134+
requestBody:
135+
description: Submodel Descriptor object
136+
content:
137+
application/json:
138+
schema:
139+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/schemas/SubmodelDescriptor'
140+
required: true
141+
responses:
142+
'204':
143+
description: Submodel Descriptor updated successfully
144+
'400':
145+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/bad-request'
146+
'403':
147+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/forbidden'
148+
'404':
149+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/not-found'
150+
'500':
151+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/internal-server-error'
152+
default:
153+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/default'
154+
delete:
155+
tags:
156+
- Submodel Registry API
157+
summary: Deletes a Submodel Descriptor, i.e. de-registers a submodel
158+
operationId: DeleteSubmodelDescriptorById
159+
x-semanticIds:
160+
- https://admin-shell.io/aas/API/DeleteSubmodelDescriptorById/3/0
161+
responses:
162+
'204':
163+
description: Submodel Descriptor deleted successfully
164+
'400':
165+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/bad-request'
166+
'403':
167+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/forbidden'
168+
'404':
169+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/not-found'
170+
'500':
171+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/internal-server-error'
172+
/description:
173+
get:
174+
tags:
175+
- Description API
176+
summary: Returns the self-describing information of a network resource (ServiceDescription)
177+
operationId: GetDescription
178+
x-semanticIds:
179+
- https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0
180+
responses:
181+
'200':
182+
description: Requested Description
183+
content:
184+
application/json:
185+
schema:
186+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/schemas/ServiceDescription'
187+
'403':
188+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/forbidden'
189+
default:
190+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/default'

‎SubmodelRegistryServiceSpecification/V3.0_SSP-002.yaml‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
openapi: 3.0.3
2+
info:
3+
title: DotAAS Part 2 | HTTP/REST | Submodel Registry Service Specification
4+
description: >-
5+
The Read Profile of the Submodel Registry Service Specification as part of the [Specification of the Asset Administration Shell: Part 2](http://industrialdigitaltwin.org/en/content-hub).
6+
7+
Publisher: Industrial Digital Twin Association (IDTA) April 2023
8+
contact:
9+
name: Industrial Digital Twin Association (IDTA)
10+
email: [email protected]
11+
license:
12+
name: CC BY 4.0
13+
url: https://creativecommons.org/licenses/by/4.0/
14+
version: V3.0.1_SSP-002
15+
servers:
16+
- url: '{protocol}://{host_name}:{port}/api/{version_prefix}'
17+
variables:
18+
protocol:
19+
description: 'Allows access through http and https (recommended)'
20+
enum:
21+
- 'http'
22+
- 'https'
23+
default: 'https'
24+
host_name:
25+
default: admin-shell.io
26+
description: 'Hostname of server hosting the api'
27+
port:
28+
enum:
29+
- '80'
30+
- '443'
31+
default: '443'
32+
description: '80 is default for http, 443 for https'
33+
version_prefix:
34+
enum:
35+
- 'v3.0'
36+
default: v3.0
37+
paths:
38+
/submodel-descriptors:
39+
get:
40+
tags:
41+
- Submodel Registry API
42+
summary: Returns all Submodel Descriptors
43+
operationId: GetAllSubmodelDescriptors
44+
x-semanticIds:
45+
- https://admin-shell.io/aas/API/GetAllSubmodelDescriptors/3/0
46+
parameters:
47+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/parameters/Limit'
48+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/parameters/Cursor'
49+
responses:
50+
'200':
51+
description: Requested Submodel Descriptors
52+
content:
53+
application/json:
54+
schema:
55+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/schemas/GetSubmodelDescriptorsResult'
56+
'400':
57+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/bad-request'
58+
'403':
59+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/forbidden'
60+
'404':
61+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/not-found'
62+
'500':
63+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/internal-server-error'
64+
default:
65+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/default'
66+
/submodel-descriptors/{submodelIdentifier}:
67+
parameters:
68+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/parameters/SubmodelIdentifier'
69+
get:
70+
tags:
71+
- Submodel Registry API
72+
summary: Returns a specific Submodel Descriptor
73+
operationId: GetSubmodelDescriptorById
74+
x-semanticIds:
75+
- https://admin-shell.io/aas/API/GetSubmodelDescriptorById/3/0
76+
responses:
77+
'200':
78+
description: Requested Submodel Descriptor
79+
content:
80+
application/json:
81+
schema:
82+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/schemas/SubmodelDescriptor'
83+
'400':
84+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/bad-request'
85+
'403':
86+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/forbidden'
87+
'404':
88+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/not-found'
89+
'500':
90+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/internal-server-error'
91+
default:
92+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/default'
93+
94+
/description:
95+
get:
96+
tags:
97+
- Description API
98+
summary: Returns the self-describing information of a network resource (ServiceDescription)
99+
operationId: GetDescription
100+
x-semanticIds:
101+
- https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0
102+
responses:
103+
'200':
104+
description: Requested Description
105+
content:
106+
application/json:
107+
schema:
108+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/schemas/ServiceDescription'
109+
'403':
110+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/forbidden'
111+
default:
112+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/default'

0 commit comments

Comments
 (0)