TRG 1.08 - Interface documentation (APIs)
| Status | Created | Post-History |
|---|---|---|
| Active | 01-Aug-2024 | |
| Draft | 21-Mar-2024 | Transferred from Release Acceptance Criteria into TRG |
Why
Interface documentation is crucial to interact with components. It fundamentally enables others to consume your APIs.
Description
- The interface documentation should be either stored in the folder
/docs/apiasopenAPI.yamlor referenced in the.tractusxmeta file as reachable document (like GitHub release asset) through theopenApiSpecskey- It must be in the OpenAPI standard
- It must be at least version 2
- It must contain all interfaces
- It must be up-to-date for the latest released component version
- It must be in the OpenAPI standard
Best Practice
- consider functional and non-functional commitments of each interface
- make sure that the context of a request is understandable, like the sequence of API calls
- anchor a link to your Interface documentation within your
README.md(see TRG 1.01)