This is the repository for the AAS API Definitions

This repository contains specifications of the Asset Administration Shell APIs, including in particular the normative OpenAPI files of the AAS HTTP/REST API. These API descriptions are derived from the document series, part 2, "Specification of the Asset Administration Shell - Part 2" published by the IDTA.

Content

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:

API Versions in GitHub Branches

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 therefore 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.

Releases

The following versioning scheme is applied for release tags: 'V\.\.\'. Major versions indicate breaking changes while minor updates are backward compatible. The patch position is increased whenever bugfixes need to be applied. The following release contains the latest version of the AAS schemas (see also the releases section of this repository):

• 3.0.3 is the bugfix release for the V3.0.3 version of the AAS APIs, containing the normative schemas for the published document "Specification of the Asset Administration Shell - Part 2: Application Programming Interfaces - Version 3.0.3". Use this release if you want to work with the latest specified AAS version.

Previous releases (deprecated by 3.0.3):

• 3.0.2 is the bugfix release for the V3.0.2 version of the AAS APIs, containing the normative schemas for the published document "Specification of the Asset Administration Shell - Part 2: Application Programming Interfaces - Version 3.0.2".

• 3.0.1 is the bugfix release for the V3.0.1 version of the AAS APIs, containing the normative schemas for the published document "Specification of the Asset Administration Shell - Part 2: Application Programming Interfaces - Version 3.0.1".

• 3.0 is the first major release for the AAS APIs, containing the normative API descriptions for the published document "Specification of the Asset Administration Shell - Part 2: Application Programming Interfaces - Version 3.0".

Contributing

Feature requests, reports about inconsistencies, mistakes etc. are highly welcome! Please submit a new issue.

If you want to contribute, see CONTRIBUTING.md.

SwaggerHub GitHub Synchronization

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 time when the current token expires, the synchronization will fail and a new token needs to be added through the IDTA repository management team.