-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathV3.0_SSP-001.yaml
257 lines (256 loc) · 10.8 KB
/
V3.0_SSP-001.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
openapi: 3.0.3
info:
title: DotAAS Part 2 | HTTP/REST | AASX File Server Service Specification
description: >-
The File Server Service Specification as part of the [Specification of the Asset Administration Shell: Part 2](http://industrialdigitaltwin.org/en/content-hub).
Publisher: Industrial Digital Twin Association (IDTA) 2023
contact:
name: Industrial Digital Twin Association (IDTA)
email: [email protected]
license:
name: CC BY 4.0
url: https://creativecommons.org/licenses/by/4.0/
version: V3.0.3_SSP-001
x-profile-identifier: https://admin-shell.io/aas/API/3/0/AasxFileServerServiceSpecification/SSP-001
termsOfService: https://github.com/admin-shell-io/aas-specs
servers:
- url: '{protocol}://{host_name}:{port}/api/{version_prefix}'
variables:
protocol:
description: 'Allows access through http and https (recommended)'
enum:
- 'http'
- 'https'
default: 'https'
host_name:
default: admin-shell.io
description: 'Hostname of server hosting the api'
port:
enum:
- '80'
- '443'
default: '443'
description: '80 is default for http, 443 for https'
version_prefix:
enum:
- 'v3.0'
default: v3.0
paths:
/packages:
get:
tags:
- AASX File Server API
summary: Returns a list of available AASX packages at the server
operationId: GetAllAASXPackageIds
x-semanticIds:
- https://admin-shell.io/aas/API/GetAllAASXPackageIds/3/0
parameters:
- name: aasId
in: query
description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
required: false
style: form
explode: true
schema:
type: string
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/parameters/Limit'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/parameters/Cursor'
responses:
'200':
description: Requested package list
content:
application/json:
schema:
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/schemas/GetPackageDescriptionsResult'
'400':
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/bad-request'
'401':
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/unauthorized'
'403':
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/forbidden'
'500':
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/internal-server-error'
default:
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/default'
post:
tags:
- AASX File Server API
summary: Stores the AASX package at the server
operationId: PostAASXPackage
x-semanticIds:
- https://admin-shell.io/aas/API/PostAASXPackage/3/0
requestBody:
description: AASX package
content:
multipart/form-data:
schema:
type: object
properties:
aasIds:
type: array
items:
type: string
file:
type: string
format: binary
fileName:
type: string
encoding:
file:
contentType: application/asset-administration-shell-package
required: true
responses:
'201':
description: AASX package stored successfully
headers:
Location:
description: URL of the newly created resource
schema:
type: string
content:
application/json:
schema:
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/schemas/PackageDescription'
'400':
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/bad-request'
'401':
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/unauthorized'
'403':
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/forbidden'
'409':
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/conflict'
'500':
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/internal-server-error'
default:
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/default'
/packages/{packageId}:
parameters:
- name: packageId
in: path
description: The package Id (UTF8-BASE64-URL-encoded)
required: true
style: simple
explode: true
schema:
type: string
get:
tags:
- AASX File Server API
summary: Returns a specific AASX package from the server
operationId: GetAASXByPackageId
x-semanticIds:
- https://admin-shell.io/aas/API/GetAASXByPackageId/3/0
responses:
'200':
description: Requested AASX package
headers:
X-FileName:
schema:
type: string
description: Filename of the package
content:
application/asset-administration-shell-package:
schema:
type: string
format: binary
'400':
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/bad-request'
'401':
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/unauthorized'
'403':
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/forbidden'
'404':
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/not-found'
'500':
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/internal-server-error'
default:
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/default'
put:
tags:
- AASX File Server API
summary: Updates the AASX package at the server
operationId: PutAASXByPackageId
x-semanticIds:
- https://admin-shell.io/aas/API/PutAASXByPackageId/3/0
requestBody:
description: AASX package
content:
multipart/form-data:
schema:
type: object
properties:
aasIds:
type: array
items:
type: string
file:
type: string
format: binary
fileName:
type: string
encoding:
file:
contentType: application/asset-administration-shell-package
required: true
responses:
'204':
description: AASX package updated successfully
'400':
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/bad-request'
'401':
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/unauthorized'
'403':
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/forbidden'
'404':
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/not-found'
'500':
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/internal-server-error'
default:
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/default'
delete:
tags:
- AASX File Server API
summary: Deletes a specific AASX package from the server
operationId: DeleteAASXByPackageId
x-semanticIds:
- https://admin-shell.io/aas/API/DeleteAASXByPackageId/3/0
responses:
'204':
description: Deleted successfully
'400':
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/bad-request'
'401':
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/unauthorized'
'403':
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/forbidden'
'404':
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/not-found'
'500':
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/internal-server-error'
default:
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/default'
/description:
get:
tags:
- Description API
summary: Returns the self-describing information of a network resource (ServiceDescription)
operationId: GetDescription
x-semanticIds:
- https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0
responses:
'200':
description: Requested Description
content:
application/json:
schema:
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/schemas/ServiceDescription'
'400':
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/bad-request'
'403':
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/forbidden'
'404':
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/not-found'
'500':
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/internal-server-error'
default:
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.3#/components/responses/default'