Skip to content

Commit 0e84bf1

Browse files
sebbader-sapsebbaderdanielportag1zzm0
authored
Merge content of the V3.0.1 Bugfix Release to main (#174)
* part 2 domain file update - add assetkind and assettype query parameters - descriptor inherits from hasextensions - description and displayname moved up to descriptor - add response 409 conflict * correct protocolinformation according to the part 2 document - change protocolinformation/endpointProtocolVersion to array of strings - add securityAttributes * add cursor parameters and result objects * add GetPackageDescriptionsResult and path parameters aasIdentifier, idShortPath, and handleId * description -> servicedescription & codetype to max 32 * add object declaration for reference plus minor fixes to the part 1 openapi metadata attributes * add referenceparent/type=object and fix the references to the new part1 version * add File Server Service Specification in V3.0.1 * add File Server Service Specification in V3.0.1 * add Asset Administration Shell Registry Service Specification in V3.0.1 * add Asset Administration Shell Repository Service Specification in V3.0.1 * add Asset Administration Shell Repository Service Specification in V3.0.1 * add Asset Administration Shell Service Specification in V3.0.1 * add Concept Description Repository Service Specification in V3.0.1 * add Discovery Service Specification in V3.0.1 * add Entire API Collection in V3.0.1 * add Submodel Repository Service Specification in V3.0.1 * add Submodel Service Specification in V3.0.1 * delete all files and folders which are not in V3.0.1 * change README for V3.0.1 * add correct URIs to the ServiceSpecificationProfileEnum (#111) * Wrong examples for assetadministrationshelldescriptor and submodeldescriptor (#127) * fix descriptor examples * fix wrong interface values in endpoint examples * fix asstid example (#128) * fix asstid example and replace own query parameter in the discovery service with a reference * add the location header to all 201 responses (#120) * add the location header to all 201 responses apart of PostAllAssetLinksById * Remove Pagination in GetSubmodelElementByPath API Operations (#141) remove pagination from GetSubmodelElementByPath * remove level param from PutSubmodelById (#139) * remove level param from all GetSubmodelById-Refs (#138) * move DeleteSubmodelById_AasRepository on path up (#137) * remove level parameter from PostSubmodelElement * fix typos in CD ServSpec and EntireAPI * add SubmodelRegistryServiceSpecification profiles * Change enumarion into table Changed the enumeration of GitHub and SwaggerHub links to a table for better readability * Add AssetAdministrationShell-Environment Add AssetAdministrationShell-Environment link to GitHub and SwaggerHub * Add Concept Description Repo Append Line in table for Concept Description Repository Service Specification * Update ConceptDescriptionServiceSpecification Change local Path of ConceptDescriptionServiceSpecification * Update AASX-File-Server API Path Change Path of AASX-File-Server API * Update Link Entire-API-Collection Change Link of Entire-API-Collection * Add DINSPEC16593 schemas Manually add DINSPEC16593 schemas/openapi.yaml This was necessary because the domain files were are not synchronized automatically * Update Name AasxFileServerServiceSpecification Change Name from AASX-File-Server to Aasx File Server Service Specification * Update Aasx-File-Server Service Specification Swagger Link Update Aasx-File-Server Service Specification Swagger URL * Unintroduce deprecated DINSPEC16593 Remove DINSPEC16593-Schemas/openapi.yaml and line in README.md This was necessary because there is no official release in Part II Version 3.0 because there is no release of DINSPEC16593 --------- Co-authored-by: sebbader <sebastian.r.bader@web.de> Co-authored-by: Daniel Porta <108098203+danielporta@users.noreply.github.com> Co-authored-by: Nico Braunisch <nico.braunisch@tu-dresden.de>
1 parent d596288 commit 0e84bf1

File tree

23 files changed

+5370
-5426
lines changed

23 files changed

+5370
-5426
lines changed

‎AasxFileServerServiceSpecification/V3.0_SSP-001.yaml

Lines changed: 51 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,25 @@
11
openapi: 3.0.3
22
info:
33
title: DotAAS Part 2 | HTTP/REST | AASX File Server Service Specification
4-
description: "The File Server Service Specification as part of Details of the Asset Administration Shell Part 2. Publisher: Industrial Digital Twin Association (IDTA) 2023"
4+
description: >-
5+
The File Server 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) 2023
58
contact:
69
name: Industrial Digital Twin Association (IDTA)
710
email: info@idtwin.org
8-
license:
11+
license:
912
name: CC BY 4.0
1013
url: https://creativecommons.org/licenses/by/4.0/
11-
version: V3.0_SSP-001
14+
version: V3.0.1_SSP-001
1215
termsOfService: https://github.com/admin-shell-io/aas-specs
1316
servers:
1417
- url: '{protocol}://{host_name}:{port}/api/{version_prefix}'
1518
variables:
1619
protocol:
1720
description: 'Allows access through http and https (recommended)'
1821
enum:
19-
- 'http'
22+
- 'http'
2023
- 'https'
2124
default: 'https'
2225
host_name:
@@ -51,25 +54,25 @@ paths:
5154
schema:
5255
type: string
5356
format: byte
54-
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Limit'
55-
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/parameters/Cursor'
57+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/parameters/Limit'
58+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/parameters/Cursor'
5659
responses:
5760
'200':
5861
description: Requested package list
5962
content:
6063
application/json:
6164
schema:
62-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/GetPackageDescriptionsResult'
65+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/schemas/GetPackageDescriptionsResult'
6366
'400':
64-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request'
67+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/bad-request'
6568
'401':
66-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized'
69+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/unauthorized'
6770
'403':
68-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden'
71+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/forbidden'
6972
'500':
70-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error'
73+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/internal-server-error'
7174
default:
72-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default'
75+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/default'
7376
post:
7477
tags:
7578
- AASX File Server API
@@ -100,22 +103,27 @@ paths:
100103
responses:
101104
'201':
102105
description: AASX package stored successfully
106+
headers:
107+
Location:
108+
description: URL of the newly created resource
109+
schema:
110+
type: string
103111
content:
104112
application/json:
105113
schema:
106-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/PackageDescription'
114+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/schemas/PackageDescription'
107115
'400':
108-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request'
116+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/bad-request'
109117
'401':
110-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized'
118+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/unauthorized'
111119
'403':
112-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden'
120+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/forbidden'
113121
'409':
114-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/conflict'
122+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/conflict'
115123
'500':
116-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error'
124+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/internal-server-error'
117125
default:
118-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default'
126+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/default'
119127
/packages/{packageId}:
120128
parameters:
121129
- name: packageId
@@ -148,17 +156,17 @@ paths:
148156
type: string
149157
format: binary
150158
'400':
151-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request'
159+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/bad-request'
152160
'401':
153-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized'
161+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/unauthorized'
154162
'403':
155-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden'
163+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/forbidden'
156164
'404':
157-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found'
165+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/not-found'
158166
'500':
159-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error'
167+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/internal-server-error'
160168
default:
161-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default'
169+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/default'
162170
put:
163171
tags:
164172
- AASX File Server API
@@ -190,17 +198,17 @@ paths:
190198
'204':
191199
description: AASX package updated successfully
192200
'400':
193-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request'
201+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/bad-request'
194202
'401':
195-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized'
203+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/unauthorized'
196204
'403':
197-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden'
205+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/forbidden'
198206
'404':
199-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found'
207+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/not-found'
200208
'500':
201-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error'
209+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/internal-server-error'
202210
default:
203-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default'
211+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/default'
204212
delete:
205213
tags:
206214
- AASX File Server API
@@ -212,17 +220,17 @@ paths:
212220
'204':
213221
description: Deleted successfully
214222
'400':
215-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request'
223+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/bad-request'
216224
'401':
217-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/unauthorized'
225+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/unauthorized'
218226
'403':
219-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden'
227+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/forbidden'
220228
'404':
221-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found'
229+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/not-found'
222230
'500':
223-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error'
231+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/internal-server-error'
224232
default:
225-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default'
233+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/default'
226234
/description:
227235
get:
228236
tags:
@@ -237,14 +245,14 @@ paths:
237245
content:
238246
application/json:
239247
schema:
240-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/schemas/ServiceDescription'
248+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/schemas/ServiceDescription'
241249
'400':
242-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/bad-request'
250+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/bad-request'
243251
'403':
244-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/forbidden'
252+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/forbidden'
245253
'404':
246-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/not-found'
254+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/not-found'
247255
'500':
248-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/internal-server-error'
256+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/internal-server-error'
249257
default:
250-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0#/components/responses/default'
258+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/responses/default'

0 commit comments

Comments
 (0)