Adjust OpenAPI Files for Discovery Service Profiles #229
There are no files selected for viewing
This file contains hidden or 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 hidden or 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: API](https://industrialdigitaltwin.org/en/content-hub/aasspecifications). | ||||||
|
|
||||||
| Publisher: Industrial Digital Twin Association (IDTA) January 2025 | ||||||
| contact: | ||||||
| name: Industrial Digital Twin Association (IDTA) | ||||||
| email: info@idtwin.org | ||||||
| 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' | ||||||
BirgitBoss marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| - url: 'https://example.com/' | ||||||
BirgitBoss marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| 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 or the global asset ID | ||||||
| operationId: GetAllAssetAdministrationShellIdsByAssetLink | ||||||
| x-semanticIds: | ||||||
| - https://admin-shell.io/aas/API/GetAllAssetAdministrationShellIdsByAssetLink/3/0 | ||||||
|
There was a problem hiding this comment.
Suggested change
There was a problem hiding this comment. ah, I just realize that this operation hasn't been touched at all with V3.1.0, therefore, I left the x-semanticId at .../3/0 on purpose. Same also for GetAllAssetLinksById. There was a problem hiding this comment. ok, so for API-operations etc. we do no increase versions (admin-shell-io/aas-specs-metamodel#366), only for classes |
||||||
| 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 | ||||||
| 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 or the global asset ID | ||||||
| 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. Search for the global asset ID is supported by setting "name" to "globalAssetId" (see Constraint AASd-116). | ||||||
| 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 | ||||||
| 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. The global asset ID is returned as specific asset ID with "name" equal to "globalAssetId" (see Constraint AASd-116). | ||||||
| operationId: GetAllAssetLinksById | ||||||
| x-semanticIds: | ||||||
| - https://admin-shell.io/aas/API/GetAllAssetLinksById/3/0 | ||||||
sebbader-sap marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| responses: | ||||||
| '200': | ||||||
| description: Requested specific Asset identifiers (including the global asset ID represented by a specific asset ID) | ||||||
| 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 | ||||||
| operationId: PostAllAssetLinksById | ||||||
| x-semanticIds: | ||||||
| - https://admin-shell.io/aas/API/PostAllAssetLinksById/3/0 | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| requestBody: | ||||||
| description: A set of 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' | ||||||
| required: true | ||||||
| responses: | ||||||
| '201': | ||||||
| description: Specific asset identifiers created successfully | ||||||
| content: | ||||||
| application/json: | ||||||
| schema: | ||||||
| type: array | ||||||
| items: | ||||||
| $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.0#/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: | ||||||
BirgitBoss marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| tags: | ||||||
| - Asset Administration Shell Basic Discovery API | ||||||
| summary: Deletes specified specific asset identifiers linked to an Asset Administration Shell: discovery via these specific asset IDs shall not be supported any longer | ||||||
| operationId: DeleteAllAssetLinksById | ||||||
| x-semanticIds: | ||||||
| - https://admin-shell.io/aas/API/DeleteAllAssetLinksById/3/0 | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| 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 | ||||||
|
There was a problem hiding this comment.
Suggested change
There was a problem hiding this comment. no change compared to 3.0? Since Classes changed version then API operations probably also need to be increased (even if class itself was not changed neither...) |
||||||
| 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.
Uh oh!
There was an error while loading. Please reload this page.