Adjust OpenAPI Files for Discovery Service Profiles #229
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,174 @@ | ||||||
| openapi: 3.0.3 | ||||||
| info: | ||||||
| title: DotAAS Part 2 | HTTP/REST | Discovery Service Specification (V3.1 Draft, not released) | ||||||
| description: >- | ||||||
| The entire Full Profile of the Discovery Service Specification as part of the [Specification of the Asset Administration Shell: Part 2](http://industrialdigitaltwin.org/en/content-hub). | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| Publisher: Industrial Digital Twin Association (IDTA) April 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.1.0_SSP-001 | ||||||
| x-profile-identifier: https://admin-shell.io/aas/API/3/1/DiscoveryServiceSpecification/SSP-001 | ||||||
| servers: | ||||||
| - url: 'https://admin-shell.io/api/v3.1' | ||||||
|
There was a problem hiding this comment. only v3 or v3.1 correct in this context? There was a problem hiding this comment. Both are possible. I feel like "v3.1" is closer to the profile version. Doesn't really matter. There was a problem hiding this comment. But it is a url? And we recommend in endpoints to just use major version |
||||||
| - url: 'https://example.com/' | ||||||
|
There was a problem hiding this comment. To make clear that the "/api/v3.1" path segments are not mandatory. |
||||||
|
|
||||||
| paths: | ||||||
| /lookup/shells: | ||||||
| get: | ||||||
| deprecated: true | ||||||
| tags: | ||||||
| - Asset Administration Shell Basic Discovery API | ||||||
| summary: Returns a list of Asset Administration Shell ids linked to specific Asset identifiers | ||||||
| operationId: GetAllAssetAdministrationShellIdsByAssetLink | ||||||
| x-semanticIds: | ||||||
| - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellIdsByAssetLink/3/0 | ||||||
| parameters: | ||||||
| - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/AssetIds' | ||||||
| - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/Limit' | ||||||
| - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/Cursor' | ||||||
| responses: | ||||||
| '200': | ||||||
| description: Requested Asset Administration Shell ids | ||||||
sebbader-sap marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| content: | ||||||
| application/json: | ||||||
| schema: | ||||||
| allOf: | ||||||
| - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/schemas/PagedResult' | ||||||
| - type: object | ||||||
| properties: | ||||||
| result: | ||||||
| type: array | ||||||
| items: | ||||||
| type: string | ||||||
| default: | ||||||
| $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/default' | ||||||
| /lookup/shellsByAssetLink: | ||||||
| post: | ||||||
| tags: | ||||||
| - Asset Administration Shell Basic Discovery API | ||||||
| summary: Returns a list of Asset Administration Shell ids linked to specific Asset identifiers | ||||||
| operationId: SearchAllAssetAdministrationShellIdsByAssetLink | ||||||
| x-semanticIds: | ||||||
| - https://admin-shell.io/aas/API/SearchAllAssetAdministrationShellIdsByAssetLink/3/1 | ||||||
| parameters: | ||||||
| - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/Limit' | ||||||
| - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/Cursor' | ||||||
| requestBody: | ||||||
| description: A list of specific Asset identifiers | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| content: | ||||||
| application/json: | ||||||
| schema: | ||||||
| type: array | ||||||
| items: | ||||||
| '$ref': 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/schemas/AssetLink' | ||||||
| responses: | ||||||
| '200': | ||||||
| description: Requested Asset Administration Shell ids | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| content: | ||||||
| application/json: | ||||||
| schema: | ||||||
| allOf: | ||||||
| - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/schemas/PagedResult' | ||||||
| - type: object | ||||||
| properties: | ||||||
| result: | ||||||
| type: array | ||||||
| items: | ||||||
| type: string | ||||||
| '400': | ||||||
| $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/bad-request' | ||||||
| default: | ||||||
| $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/default' | ||||||
|
|
||||||
| /lookup/shells/{aasIdentifier}: | ||||||
| parameters: | ||||||
| - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/AssetAdministrationShellIdentifier' | ||||||
| get: | ||||||
| tags: | ||||||
| - Asset Administration Shell Basic Discovery API | ||||||
| summary: Returns a list of specific Asset identifiers based on an Asset Administration Shell id to edit discoverable content | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| operationId: GetAllAssetLinksById | ||||||
| x-semanticIds: | ||||||
| - https://admin-shell.io/aas/API/GetAllAssetLinksById/3/0 | ||||||
| responses: | ||||||
| '200': | ||||||
| description: Requested specific Asset identifiers | ||||||
| content: | ||||||
| application/json: | ||||||
| schema: | ||||||
| type: array | ||||||
| items: | ||||||
| $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.0#/components/schemas/SpecificAssetId' | ||||||
| '404': | ||||||
| $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/not-found' | ||||||
| default: | ||||||
| $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/default' | ||||||
| post: | ||||||
| tags: | ||||||
| - Asset Administration Shell Basic Discovery API | ||||||
| summary: Creates specific Asset identifiers linked to an Asset Administration Shell to edit discoverable content | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| operationId: PostAllAssetLinksById | ||||||
| x-semanticIds: | ||||||
| - https://admin-shell.io/aas/API/PostAllAssetLinksById/3/0 | ||||||
| requestBody: | ||||||
| description: A list of specific Asset identifiers | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| content: | ||||||
| application/json: | ||||||
| schema: | ||||||
| type: array | ||||||
| items: | ||||||
| $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/SpecificAssetId' | ||||||
| required: true | ||||||
| responses: | ||||||
| '201': | ||||||
| description: Specific Asset identifiers created successfully | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| content: | ||||||
| application/json: | ||||||
| schema: | ||||||
| type: array | ||||||
| items: | ||||||
| $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/SpecificAssetId' | ||||||
| '400': | ||||||
| $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/bad-request' | ||||||
| '404': | ||||||
| $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/not-found' | ||||||
| '409': | ||||||
| $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/conflict' | ||||||
| default: | ||||||
| $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/default' | ||||||
| delete: | ||||||
| tags: | ||||||
| - Asset Administration Shell Basic Discovery API | ||||||
| summary: Deletes all specific Asset identifiers linked to an Asset Administration Shell to edit discoverable content | ||||||
| operationId: DeleteAllAssetLinksById | ||||||
| x-semanticIds: | ||||||
| - https://admin-shell.io/aas/API/DeleteAllAssetLinksById/3/0 | ||||||
| responses: | ||||||
| '204': | ||||||
| description: Specific Asset identifiers deleted successfully | ||||||
| '404': | ||||||
| $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/not-found' | ||||||
| default: | ||||||
| $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/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.1.0#/components/schemas/ServiceDescription' | ||||||
| default: | ||||||
| $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/default' | ||||||
File renamed without changes.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is now V3.1, no? But all changes are for V3.0.1 but you want to merge it to branch of V3.1?