This repository contains specifications of the Asset Administration Shell API, including in particular the normative OpenAPI files of the AAS REST API. These API descriptions are derived from the document series, part 2, "Details of the Asset Administration Shell" published by the Platform Industrie 4.0 and IDTA.
This repository provides the OpenAPI files published in the SwaggerHub organization Plattform_i40. All published SwaggerHub APIs are synchronized all the time with the respective folders in this repository using the GitHub Integration feature. In particular, the following APIs are contained:
- Entire-API-Collection/openapi.yaml matches the Entire-API-Collection API at SwaggerHub
- AssetAdministrationShell-Environment/openapi.yaml matches the AssetAdministrationShell-Environment API at SwaggerHub
- AssetAdministrationShell-API/openapi.yaml matches the AssetAdministrationShell API at SwaggerHub
- Submodel-API/openapi.yaml matches the Submodel API at SwaggerHub
- AASX-File-Server/openapi.yaml matches the AASX-File-Server API at SwaggerHub
- Registry-and-Discovery/openapi.yaml matches the Registry-and-Discovery API at SwaggerHub
The following domains are synchronized manually as domain synchronization is not yet available in SwaggerHub:
- Part1-MetaModel-Schemas/openapi.yaml matches the Part1-MetaModel-Schemas Domain at SwaggerHub
- Part2-API-Schemas/openapi.yaml matches the Part2-API-Schemas Domain at SwaggerHub
- DINSPEC16593-Schemas/openapi.yaml matches the DINSPEC16593-Schemas Domain at SwaggerHub
The main branch contains the latest released version of all APIs and Domains. Current and previously released states are tagged with the corresponding release version in this repository, and marked with the Published tag in SwaggerHub.
Working versions may be marked as private in SwaggerHub and therfore may not be visible to the public audience yet. In this repository, working versions appear as branches named after the target release version. Note: In order to synchronize with the same GitHub branch, all versions should follow the exact same pattern.
Feature requests, reports about inconsistencies, mistakes etc. are highly welcome! Please submit a new issue.
If you want to contribute, see CONTRIBUTING.md.
SwaggerHub requires a GitHub Access Token with repo permissions. It is good practice that the selected token has a defined expiration date. Therefore, at some point in the future when the current token expires, the synchronization will fail and a new token needs to be added through the IDTA repository management team.