TRG 1.08 - Interface documentation (APIs)
caution
Proposed release date: 15th of January 2024
Status | Created | Post-History |
---|---|---|
Draft | 21-Mar-2024 | Transferred from Release Acceptance Criteria into TRG |
Why
Interface documentation is crucial to interact with your FOSS component: it fundamentally enables others to consume your APIs.
Description
- API documentation contains all interfaces. It must be up-to-date for the latest released component version
- The interface documentation must be stored in the folder
/docs/api
- Functional and non-functional commitment of the interface
Best Practice
- adhere to standard OpenAPI
- consider functional and non-functional commitments of each interface
- context of a request must be clear (sequence of API calls)
- anchor a link to your Interface documentation within your
README.md
(see TRG 1.01)