Skip to content

Commit 9064ad4

Browse files
sebbader-sapBirgitBoss
sebbader-sap
and
BirgitBoss
authored
New AAS Registry Profile "Minimal Read" (SSP-005) (#420)
* add new minimal read profile for the ass registry * Update AssetAdministrationShellRegistryServiceSpecification/V3.1_SSP-005.yaml Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> * Update AssetAdministrationShellRegistryServiceSpecification/V3.1_SSP-005.yaml Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> * fix typo in operation name * Update AssetAdministrationShellRegistryServiceSpecification/V3.1_SSP-005.yaml Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> * rename new ssp from registry to asset administration shell registry --------- Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com>
1 parent fdfb9d6 commit 9064ad4

File tree

6 files changed

+131
-5
lines changed

6 files changed

+131
-5
lines changed

‎AssetAdministrationShellRegistryServiceSpecification/V3.1_SSP-001.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ paths:
2525
operationId: GetAllAssetAdministrationShellDescriptors
2626
x-semanticIds:
2727
- https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptors/3/0
28-
- https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptorsByAssetKind/3/0
2928
- https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptorsByAssetType/3/0
3029
parameters:
3130
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/Limit'

‎AssetAdministrationShellRegistryServiceSpecification/V3.1_SSP-002.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ paths:
2525
operationId: GetAllAssetAdministrationShellDescriptors
2626
x-semanticIds:
2727
- https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptors/3/0
28-
- https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptorsByAssetKind/3/0
2928
- https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptorsByAssetType/3/0
3029
parameters:
3130
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/Limit'

‎AssetAdministrationShellRegistryServiceSpecification/V3.1_SSP-005.yaml

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
openapi: 3.0.3
2+
info:
3+
title: DotAAS Part 2 | HTTP/REST | Asset Administration Shell Registry Service Specification
4+
description: >-
5+
The Minimal Read Profile of the Asset Administration Shell Registry Service Specification as part of the [Specification of the Asset Administration Shell: Part 2](https://industrialdigitaltwin.org/en/content-hub/aasspecifications).
6+
7+
Publisher: Industrial Digital Twin Association (IDTA) 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-005
15+
x-profile-identifier: https://admin-shell.io/aas/API/3/1/AssetAdministrationShellRegistryServiceSpecification/SSP-005
16+
servers:
17+
- url: 'https://admin-shell.io/api/v3/'
18+
- url: 'https://example.com/'
19+
paths:
20+
/shell-descriptors:
21+
get:
22+
tags:
23+
- Asset Administration Shell Registry API
24+
summary: Returns all Asset Administration Shell Descriptors
25+
operationId: GetAllAssetAdministrationShellDescriptors
26+
x-semanticIds:
27+
- https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptors/3/1
28+
- https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptorsByAssetType/3/0
29+
parameters:
30+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/Limit'
31+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/Cursor'
32+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/AssetKind'
33+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/AssetType'
34+
responses:
35+
'200':
36+
description: Requested Asset Administration Shell Descriptors
37+
content:
38+
application/json:
39+
schema:
40+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/schemas/GetAssetAdministrationShellDescriptorsResult'
41+
'400':
42+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/bad-request'
43+
'403':
44+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/forbidden'
45+
'500':
46+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/internal-server-error'
47+
default:
48+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/default'
49+
/shell-descriptors/{aasIdentifier}:
50+
get:
51+
tags:
52+
- Asset Administration Shell Registry API
53+
summary: Returns a specific Asset Administration Shell Descriptor
54+
operationId: GetAssetAdministrationShellDescriptorById
55+
x-semanticIds:
56+
- https://admin-shell.io/aas/API/GetAssetAdministrationShellDescriptorById/3/1
57+
parameters:
58+
- name: aasIdentifier
59+
in: path
60+
description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
61+
required: true
62+
style: simple
63+
explode: false
64+
schema:
65+
type: string
66+
responses:
67+
'200':
68+
description: Requested Asset Administration Shell Descriptor
69+
content:
70+
application/json:
71+
schema:
72+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/schemas/AssetAdministrationShellDescriptor'
73+
'400':
74+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/bad-request'
75+
'403':
76+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/forbidden'
77+
'404':
78+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/not-found'
79+
'500':
80+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/internal-server-error'
81+
default:
82+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/default'
83+
84+
/description:
85+
get:
86+
tags:
87+
- Description API
88+
summary: Returns the self-describing information of a network resource (ServiceDescription)
89+
operationId: GetSelfDescription
90+
x-semanticIds:
91+
- https://admin-shell.io/aas/API/GetSelfDescription/3/1
92+
responses:
93+
'200':
94+
description: Requested Description
95+
content:
96+
application/json:
97+
schema:
98+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/schemas/ServiceDescription'
99+
'403':
100+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/forbidden'
101+
default:
102+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/default'

‎Entire-API-Collection/V3.1.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6359,7 +6359,6 @@ paths:
63596359
operationId: GetAllAssetAdministrationShellDescriptors
63606360
x-semanticIds:
63616361
- https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptors/3/0
6362-
- https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptorsByAssetKind/3/0
63636362
- https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptorsByAssetType/3/0
63646363
parameters:
63656364
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/Limit'

‎documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ Major Changes:
1919
* deprecated: operation GetAllAssetAdministrationShellIdsByAssetLink
2020
* new: operation SearchAllAssetAdministrationShellIdsByAssetLink (as substitute for GetAllAssetAdministrationShellIdsByAssetLink) (https://github.com/admin-shell-io/aas-specs-api/issues/19[#19])
2121
* new: Profile for Discovery Service: Read Only SSP-002 (https://github.com/admin-shell-io/aas-specs-api/issues/201[#201])
22-
* update: Terms and Definitions adopted to IEC 63278-1:2023 (before IEC 63278-1 Draft July 2022 was the basis), also abbreviations partly adopted; changed definitions (https://github.com/admin-shell-io/aas-specs/issues/365[#365]):
22+
* new: Profile for the Asset Administration Shell Registry: Minimal Read SSP-005 (https://github.com/admin-shell-io/aas-specs-api/issues/201[#201])
23+
* update: Terms and Definitions adopted to IEC 63278-1:2023 (before IEC 63278-1 Draft July 2022 was the basis), also abbreviations partly adopted; changed definitions (https://github.com/admin-shell-io/aas-specs/issues/210[#210]):
2324
** changed: interface
2425
** changed: service
2526
* update: Individual versioning of datatype IDs, operations, interfaces etc. (https://github.com/admin-shell-io/aas-specs-api/issues/247[#247])

‎documentation/IDTA-01002-3/modules/ROOT/pages/http-rest-api/service-specifications-and-profiles.adoc

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -353,9 +353,10 @@ See: https://app.swaggerhub.com/apis/Plattform_i40/AasxFileServerServiceSpecific
353353
|===
354354
h|Service Specification / Profiles h|Description
355355
|<<asset-administration-shell-registry-service-specification-ssp-001,AssetAdministrationShellRegistryServiceSpecification/SSP-001>> |Full profile
356-
|<<asset-administration-shell-registry-service-specification-ssp-002,AssetAdministrationShellRegistryServiceSpecification/SSP-002>> |Only reads operations; is included in the profile AssetAdministrationShellRegistryServiceSpecification/SSP-001.
356+
|<<asset-administration-shell-registry-service-specification-ssp-002,AssetAdministrationShellRegistryServiceSpecification/SSP-002>> |Only read operations; is included in the profile AssetAdministrationShellRegistryServiceSpecification/SSP-001.
357357
|<<asset-administration-shell-registry-service-specification-ssp-003,AssetAdministrationShellRegistryServiceSpecification/SSP-003>> |Bulk write and delete operations.
358358
|<<asset-administration-shell-registry-service-specification-ssp-004,AssetAdministrationShellRegistryServiceSpecification/SSP-004>> |Query operations.
359+
|<<asset-administration-shell-registry-service-specification-ssp-005,AssetAdministrationShellRegistryServiceSpecification/SSP-005>> |Only reads operations on AAS Descriptors; is included in the profile AssetAdministrationShellRegistryServiceSpecification/SSP-001 and AssetAdministrationShellRegistryServiceSpecification/SSP-002.
359360
|===
360361

361362
[#asset-administration-shell-registry-service-specification-ssp-001]
@@ -465,6 +466,31 @@ xref:specification/interfaces.adoc#GetSelfDescription[GetDescription]
465466

466467
See: https://app.swaggerhub.com/apis/Plattform_i40/AssetAdministrationShellRegistryServiceSpecification/V3.1.0_SSP-004
467468

469+
[#asset-administration-shell-registry-service-specification-ssp-005]
470+
=== Asset Administration Shell Registry Service Specification – Minimal Read Profile
471+
472+
[%autowidth,width="100%",cols="36%,64%",options="header",]
473+
|===
474+
h|Name: h|AAS Registry Minimal Read Profile
475+
h|Profile Identifier: |`\https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRegistryServiceSpecification/SSP-005`
476+
h|Feature h|Appearance
477+
|APIs and API Operations a|
478+
_AAS Registry API:_ +
479+
xref:specification/interfaces.adoc#GetAllAssetAdministrationShellDescriptors[GetAllAssetAdministrationShellDescriptors] +
480+
xref:specification/interfaces.adoc#GetAssetAdministrationShellDescriptorById[GetAssetAdministrationShellDescriptorById]
481+
482+
483+
_Description API:_ +
484+
xref:specification/interfaces.adoc#GetSelfDescription[GetDescription]
485+
486+
|xref:specification/interfaces-operation-parameters.adoc#SerializationModifier[SerializationModifier] |not applicable
487+
|SerializationFormat |JSON
488+
|Pagination |supported
489+
|===
490+
491+
See: https://app.swaggerhub.com/apis/Plattform_i40/AssetAdministrationShellRegistryServiceSpecification/V3.1.0_SSP-005
492+
493+
468494
[#submodel-registry-service-specification]
469495
== Submodel Registry Service Specification
470496

0 commit comments

Comments
 (0)