Add eventing with CloudEvents-based events, Event Interface, and Event profiles

AssetAdministrationShellRepositoryServiceSpecification/V3.3_SSP-007.yaml

@@ -0,0 +1,162 @@
+openapi: 3.0.3
+info:
+  title: DotAAS Part 2 | HTTP/REST | Asset Administration Shell Repository Service Specification
+  description: >-
+    The Event Profile of the Asset Administration Shell Repository Service Specification as part of the [Specification of the Asset Administration Shell: Part 2](https://industrialdigitaltwin.org/en/content-hub/aasspecifications).
+
+    Copyright: Industrial Digital Twin Association (IDTA) 2026
+  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.3.0_SSP-007
+  x-profile-identifier: https://admin-shell.io/aas/API/3/3/AssetAdministrationShellRepositoryServiceSpecification/SSP-007
+servers:
+- url: 'https://admin-shell.io/api/v3/'
+- url: 'https://example.com/'
+
+paths:
+  /events:
+    get:
+      tags:
+        - Event API
+      summary: Returns the events provided by the service
+      operationId: GetAllEvents
+      x-semanticIds:
+        - https://admin-shell.io/aas/API/GetAllEvents/3/3
+      parameters:
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventTypes'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventAasIdentifiers'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventSubmodelIdentifiers'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventCdIdentifiers'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventIdShortPath'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventGlobalAssetIds'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventSemanticIds'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventSubmodelSemanticIds'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventSince'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/LastEventId'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/Limit'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/Cursor'
+      responses:
+        '200':
+          description: Requested events
+          content:
+            application/json:
+              schema:
+                $ref: '../Part2-API-Schemas/openapi.yaml#/components/schemas/GetEventsResult'
+        '400':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/bad-request'
+        '401':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/unauthorized'
+        '403':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/forbidden'
+        '404':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/not-found'
+        '500':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/internal-server-error'
+        default:
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/default'
+
+  /events/$value:
+    get:
+      tags:
+        - Event API
+      summary: Returns the events provided by the service with the event data in Content Value
+      operationId: GetAllEvents-ValueOnly
+      x-semanticIds:
+        - https://admin-shell.io/aas/API/GetAllEvents/3/3
+      parameters:
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventTypes'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventAasIdentifiers'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventSubmodelIdentifiers'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventCdIdentifiers'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventIdShortPath'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventGlobalAssetIds'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventSemanticIds'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventSubmodelSemanticIds'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventSince'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/LastEventId'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/Limit'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/Cursor'
+      responses:
+        '200':
+          description: Requested events with the event data in Content Value
+          content:
+            application/json:
+              schema:
+                $ref: '../Part2-API-Schemas/openapi.yaml#/components/schemas/GetEventsResult'
+        '400':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/bad-request'
+        '401':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/unauthorized'
+        '403':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/forbidden'
+        '404':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/not-found'
+        '500':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/internal-server-error'
+        default:
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/default'
+
+  /events/$reference:
+    get:
+      tags:
+        - Event API
+      summary: Returns the events provided by the service with the event data in Content Reference
+      operationId: GetAllEvents-Reference
+      x-semanticIds:
+        - https://admin-shell.io/aas/API/GetAllEvents/3/3
+      parameters:
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventTypes'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventAasIdentifiers'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventSubmodelIdentifiers'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventCdIdentifiers'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventIdShortPath'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventGlobalAssetIds'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventSemanticIds'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventSubmodelSemanticIds'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventSince'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/LastEventId'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/Limit'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/Cursor'
+      responses:
+        '200':
+          description: Requested events with the event data in Content Reference
+          content:
+            application/json:
+              schema:
+                $ref: '../Part2-API-Schemas/openapi.yaml#/components/schemas/GetEventsResult'
+        '400':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/bad-request'
+        '401':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/unauthorized'
+        '403':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/forbidden'
+        '404':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/not-found'
+        '500':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/internal-server-error'
+        default:
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/default'
+
+  /description:
+    get:
+      tags:
+        - Description API
+      summary: Returns the self-describing information of a network resource (ServiceDescription)
+      operationId: GetSelfDescription
+      x-semanticIds:
+        - https://admin-shell.io/aas/API/GetSelfDescription/3/2
+      responses:
+        '200':
+          description: Requested Description
+          content:
+            application/json:
+              schema:
+                $ref: '../Part2-API-Schemas/openapi.yaml#/components/schemas/ServiceDescription'
+        '401':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/unauthorized'
+        '403':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/forbidden'

ConceptDescriptionRepositoryServiceSpecification/V3.3_SSP-004.yaml

@@ -0,0 +1,162 @@
+openapi: 3.0.3
+info:
+  title: DotAAS Part 2 | HTTP/REST | Concept Description Repository Service Specification
+  description: >-
+    The Event Profile of the Concept Description Repository Service Specification as part of the [Specification of the Asset Administration Shell: Part 2](https://industrialdigitaltwin.org/en/content-hub/aasspecifications).
+
+    Copyright: Industrial Digital Twin Association (IDTA) 2026
+  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.3.0_SSP-004
+  x-profile-identifier: https://admin-shell.io/aas/API/3/3/ConceptDescriptionRepositoryServiceSpecification/SSP-004
+servers:
+- url: 'https://admin-shell.io/api/v3/'
+- url: 'https://example.com/'
+
+paths:
+  /events:
+    get:
+      tags:
+        - Event API
+      summary: Returns the events provided by the service
+      operationId: GetAllEvents
+      x-semanticIds:
+        - https://admin-shell.io/aas/API/GetAllEvents/3/3
+      parameters:
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventTypes'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventAasIdentifiers'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventSubmodelIdentifiers'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventCdIdentifiers'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventIdShortPath'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventGlobalAssetIds'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventSemanticIds'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventSubmodelSemanticIds'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventSince'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/LastEventId'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/Limit'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/Cursor'
+      responses:
+        '200':
+          description: Requested events
+          content:
+            application/json:
+              schema:
+                $ref: '../Part2-API-Schemas/openapi.yaml#/components/schemas/GetEventsResult'
+        '400':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/bad-request'
+        '401':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/unauthorized'
+        '403':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/forbidden'
+        '404':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/not-found'
+        '500':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/internal-server-error'
+        default:
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/default'
+
+  /events/$value:
+    get:
+      tags:
+        - Event API
+      summary: Returns the events provided by the service with the event data in Content Value
+      operationId: GetAllEvents-ValueOnly
+      x-semanticIds:
+        - https://admin-shell.io/aas/API/GetAllEvents/3/3
+      parameters:
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventTypes'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventAasIdentifiers'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventSubmodelIdentifiers'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventCdIdentifiers'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventIdShortPath'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventGlobalAssetIds'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventSemanticIds'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventSubmodelSemanticIds'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventSince'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/LastEventId'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/Limit'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/Cursor'
+      responses:
+        '200':
+          description: Requested events with the event data in Content Value
+          content:
+            application/json:
+              schema:
+                $ref: '../Part2-API-Schemas/openapi.yaml#/components/schemas/GetEventsResult'
+        '400':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/bad-request'
+        '401':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/unauthorized'
+        '403':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/forbidden'
+        '404':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/not-found'
+        '500':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/internal-server-error'
+        default:
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/default'
+
+  /events/$reference:
+    get:
+      tags:
+        - Event API
+      summary: Returns the events provided by the service with the event data in Content Reference
+      operationId: GetAllEvents-Reference
+      x-semanticIds:
+        - https://admin-shell.io/aas/API/GetAllEvents/3/3
+      parameters:
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventTypes'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventAasIdentifiers'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventSubmodelIdentifiers'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventCdIdentifiers'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventIdShortPath'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventGlobalAssetIds'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventSemanticIds'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventSubmodelSemanticIds'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/EventSince'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/LastEventId'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/Limit'
+        - $ref: '../Part2-API-Schemas/openapi.yaml#/components/parameters/Cursor'
+      responses:
+        '200':
+          description: Requested events with the event data in Content Reference
+          content:
+            application/json:
+              schema:
+                $ref: '../Part2-API-Schemas/openapi.yaml#/components/schemas/GetEventsResult'
+        '400':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/bad-request'
+        '401':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/unauthorized'
+        '403':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/forbidden'
+        '404':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/not-found'
+        '500':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/internal-server-error'
+        default:
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/default'
+
+  /description:
+    get:
+      tags:
+        - Description API
+      summary: Returns the self-describing information of a network resource (ServiceDescription)
+      operationId: GetSelfDescription
+      x-semanticIds:
+        - https://admin-shell.io/aas/API/GetSelfDescription/3/2
+      responses:
+        '200':
+          description: Requested Description
+          content:
+            application/json:
+              schema:
+                $ref: '../Part2-API-Schemas/openapi.yaml#/components/schemas/ServiceDescription'
+        '401':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/unauthorized'
+        '403':
+          $ref: '../Part2-API-Schemas/openapi.yaml#/components/responses/forbidden'