Skip to content

Commit 4d221ed

Browse files
Adjust OpenAPI Files for Discovery Service Profiles (#229)
* add Discovery Service Specification V3.1_SSP-001 as own YAML file * adjust name of Discovery Service Specification SSP-002 * correct links from v3.0.1 to v3.1.0 * Update DiscoveryServiceSpecification/V3.1_SSP-001.yaml --------- Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com>
1 parent 98a9aea commit 4d221ed

File tree

3 files changed

+216
-63
lines changed

3 files changed

+216
-63
lines changed

DiscoveryServiceSpecification/V3.0_SSP-001.yaml

Lines changed: 42 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -11,83 +11,62 @@ info:
1111
license:
1212
name: CC BY 4.0
1313
url: https://creativecommons.org/licenses/by/4.0/
14-
version: V3.1.0_SSP-001
15-
x-profile-identifier: https://admin-shell.io/aas/API/3/1/DiscoveryServiceSpecification/SSP-001
14+
version: V3.0.3_SSP-001
15+
x-profile-identifier: https://admin-shell.io/aas/API/3/0/DiscoveryServiceSpecification/SSP-001
1616
servers:
17-
- url: 'https://admin-shell.io/api/v3.1'
18-
- url: 'https://example.com/'
19-
17+
- url: '{protocol}://{host_name}:{port}/api/{version_prefix}'
18+
variables:
19+
protocol:
20+
description: 'Allows access through http and https (recommended)'
21+
enum:
22+
- 'http'
23+
- 'https'
24+
default: 'https'
25+
host_name:
26+
default: admin-shell.io
27+
description: 'Hostname of server hosting the api'
28+
port:
29+
enum:
30+
- '80'
31+
- '443'
32+
default: '443'
33+
description: '80 is default for http, 443 for https'
34+
version_prefix:
35+
enum:
36+
- 'v3.0'
37+
default: v3.0
2038
paths:
2139
/lookup/shells:
2240
get:
23-
deprecated: true
2441
tags:
2542
- Asset Administration Shell Basic Discovery API
2643
summary: Returns a list of Asset Administration Shell ids linked to specific Asset identifiers
2744
operationId: GetAllAssetAdministrationShellIdsByAssetLink
2845
x-semanticIds:
2946
- https://admin-shell.io/aas/API/GetAllAssetAdministrationShellIdsByAssetLink/3/0
3047
parameters:
31-
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/AssetIds'
32-
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/Limit'
33-
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/Cursor'
48+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/parameters/AssetIds'
49+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/parameters/Limit'
50+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/parameters/Cursor'
3451
responses:
3552
'200':
3653
description: Requested Asset Administration Shell ids
3754
content:
3855
application/json:
3956
schema:
4057
allOf:
41-
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/schemas/PagedResult'
58+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/schemas/PagedResult'
4259
- type: object
4360
properties:
4461
result:
4562
type: array
4663
items:
4764
type: string
4865
default:
49-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/default'
50-
/lookup/shellsByAssetLink:
51-
post:
52-
tags:
53-
- Asset Administration Shell Basic Discovery API
54-
summary: Returns a list of Asset Administration Shell ids linked to specific Asset identifiers
55-
operationId: SearchAllAssetAdministrationShellIdsByAssetLink
56-
x-semanticIds:
57-
- https://admin-shell.io/aas/API/SearchAllAssetAdministrationShellIdsByAssetLink/3/1
58-
parameters:
59-
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/Limit'
60-
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/Cursor'
61-
requestBody:
62-
description: A list of asset identifiers in the form of an AssetLink each. One AssetLink may either represent the name/value pair of a SpecificAssetId or the globalAssetId of the asset represented by the Asset Administration Shell.
63-
content:
64-
application/json:
65-
schema:
66-
type: array
67-
items:
68-
'$ref': 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/schemas/AssetLink'
69-
responses:
70-
'200':
71-
description: Requested Asset Administration Shell ids
72-
content:
73-
application/json:
74-
schema:
75-
allOf:
76-
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/schemas/PagedResult'
77-
- type: object
78-
properties:
79-
result:
80-
type: array
81-
items:
82-
type: string
83-
'400':
84-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/bad-request'
85-
default:
86-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/default'
87-
66+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/default'
8867
/lookup/shells/{aasIdentifier}:
8968
parameters:
90-
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/AssetAdministrationShellIdentifier'
69+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/parameters/AssetAdministrationShellIdentifier'
9170
get:
9271
tags:
9372
- Asset Administration Shell Basic Discovery API
@@ -103,11 +82,11 @@ paths:
10382
schema:
10483
type: array
10584
items:
106-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.0#/components/schemas/SpecificAssetId'
85+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/SpecificAssetId'
10786
'404':
108-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/not-found'
87+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/not-found'
10988
default:
110-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/default'
89+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/default'
11190
post:
11291
tags:
11392
- Asset Administration Shell Basic Discovery API
@@ -122,7 +101,7 @@ paths:
122101
schema:
123102
type: array
124103
items:
125-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.0#/components/schemas/SpecificAssetId'
104+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/SpecificAssetId'
126105
required: true
127106
responses:
128107
'201':
@@ -132,15 +111,15 @@ paths:
132111
schema:
133112
type: array
134113
items:
135-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.0#/components/schemas/SpecificAssetId'
114+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/SpecificAssetId'
136115
'400':
137-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/bad-request'
116+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/bad-request'
138117
'404':
139-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/not-found'
118+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/not-found'
140119
'409':
141-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/conflict'
120+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/conflict'
142121
default:
143-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/default'
122+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/default'
144123
delete:
145124
tags:
146125
- Asset Administration Shell Basic Discovery API
@@ -152,9 +131,9 @@ paths:
152131
'204':
153132
description: Specific Asset identifiers deleted successfully
154133
'404':
155-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/not-found'
134+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/not-found'
156135
default:
157-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/default'
136+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/default'
158137
/description:
159138
get:
160139
tags:
@@ -169,6 +148,6 @@ paths:
169148
content:
170149
application/json:
171150
schema:
172-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/schemas/ServiceDescription'
151+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/schemas/ServiceDescription'
173152
default:
174-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/default'
153+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/default'
Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
openapi: 3.0.3
2+
info:
3+
title: DotAAS Part 2 | HTTP/REST | Discovery Service Specification (V3.1 Draft, not released)
4+
description: >-
5+
The entire Full Profile of the Discovery Service Specification as part of the [Specification of the Asset Administration Shell - Part 2: API](https://industrialdigitaltwin.org/en/content-hub/aasspecifications).
6+
7+
Publisher: Industrial Digital Twin Association (IDTA) January 2025
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.1.0_SSP-001
15+
x-profile-identifier: https://admin-shell.io/aas/API/3/1/DiscoveryServiceSpecification/SSP-001
16+
servers:
17+
- url: 'https://admin-shell.io/api/v3.1'
18+
- url: 'https://example.com/'
19+
20+
paths:
21+
/lookup/shells:
22+
get:
23+
deprecated: true
24+
tags:
25+
- Asset Administration Shell Basic Discovery API
26+
summary: Returns a list of Asset Administration Shell IDs linked to specific asset identifiers or the global asset ID
27+
operationId: GetAllAssetAdministrationShellIdsByAssetLink
28+
x-semanticIds:
29+
- https://admin-shell.io/aas/API/GetAllAssetAdministrationShellIdsByAssetLink/3/0
30+
parameters:
31+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/AssetIds'
32+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/Limit'
33+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/Cursor'
34+
responses:
35+
'200':
36+
description: Requested Asset Administration Shell IDs
37+
content:
38+
application/json:
39+
schema:
40+
allOf:
41+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/schemas/PagedResult'
42+
- type: object
43+
properties:
44+
result:
45+
type: array
46+
items:
47+
type: string
48+
default:
49+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/default'
50+
/lookup/shellsByAssetLink:
51+
post:
52+
tags:
53+
- Asset Administration Shell Basic Discovery API
54+
summary: Returns a list of Asset Administration Shell IDs linked to specific asset identifiers or the global asset ID
55+
operationId: SearchAllAssetAdministrationShellIdsByAssetLink
56+
x-semanticIds:
57+
- https://admin-shell.io/aas/API/SearchAllAssetAdministrationShellIdsByAssetLink/3/1
58+
parameters:
59+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/Limit'
60+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/Cursor'
61+
requestBody:
62+
description: A list of specific asset identifiers. Search for the global asset ID is supported by setting "name" to "globalAssetId" (see Constraint AASd-116).
63+
content:
64+
application/json:
65+
schema:
66+
type: array
67+
items:
68+
'$ref': 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/schemas/AssetLink'
69+
responses:
70+
'200':
71+
description: Requested Asset Administration Shell IDs
72+
content:
73+
application/json:
74+
schema:
75+
allOf:
76+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/schemas/PagedResult'
77+
- type: object
78+
properties:
79+
result:
80+
type: array
81+
items:
82+
type: string
83+
'400':
84+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/bad-request'
85+
default:
86+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/default'
87+
88+
/lookup/shells/{aasIdentifier}:
89+
parameters:
90+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/AssetAdministrationShellIdentifier'
91+
get:
92+
tags:
93+
- Asset Administration Shell Basic Discovery API
94+
summary: Returns a list of specific asset identifiers based on an Asset Administration Shell ID to edit discoverable content. The global asset ID is returned as specific asset ID with "name" equal to "globalAssetId" (see Constraint AASd-116).
95+
operationId: GetAllAssetLinksById
96+
x-semanticIds:
97+
- https://admin-shell.io/aas/API/GetAllAssetLinksById/3/0
98+
responses:
99+
'200':
100+
description: Requested specific Asset identifiers (including the global asset ID represented by a specific asset ID)
101+
content:
102+
application/json:
103+
schema:
104+
type: array
105+
items:
106+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.0#/components/schemas/SpecificAssetId'
107+
'404':
108+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/not-found'
109+
default:
110+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/default'
111+
post:
112+
tags:
113+
- Asset Administration Shell Basic Discovery API
114+
summary: Creates specific asset identifiers linked to an Asset Administration Shell to edit discoverable content
115+
operationId: PostAllAssetLinksById
116+
x-semanticIds:
117+
- https://admin-shell.io/aas/API/PostAllAssetLinksById/3/0
118+
requestBody:
119+
description: A set of specific asset identifiers
120+
content:
121+
application/json:
122+
schema:
123+
type: array
124+
items:
125+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.0#/components/schemas/SpecificAssetId'
126+
required: true
127+
responses:
128+
'201':
129+
description: Specific asset identifiers created successfully
130+
content:
131+
application/json:
132+
schema:
133+
type: array
134+
items:
135+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.0#/components/schemas/SpecificAssetId'
136+
'400':
137+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/bad-request'
138+
'404':
139+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/not-found'
140+
'409':
141+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/conflict'
142+
default:
143+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/default'
144+
delete:
145+
tags:
146+
- Asset Administration Shell Basic Discovery API
147+
summary: Deletes specified specific asset identifiers linked to an Asset Administration Shell: discovery via these specific asset IDs shall not be supported any longer
148+
operationId: DeleteAllAssetLinksById
149+
x-semanticIds:
150+
- https://admin-shell.io/aas/API/DeleteAllAssetLinksById/3/0
151+
responses:
152+
'204':
153+
description: Specific asset identifiers deleted successfully
154+
'404':
155+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/not-found'
156+
default:
157+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/default'
158+
/description:
159+
get:
160+
tags:
161+
- Description API
162+
summary: Returns the self-describing information of a network resource (ServiceDescription)
163+
operationId: GetDescription
164+
x-semanticIds:
165+
- https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0
166+
responses:
167+
'200':
168+
description: Requested Description
169+
content:
170+
application/json:
171+
schema:
172+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/schemas/ServiceDescription'
173+
default:
174+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/default'

0 commit comments

Comments
 (0)