Skip to content

Commit

Permalink
combine trg 1.8 sentence for api spec location
Browse files Browse the repository at this point in the history
  • Loading branch information
Siegfriedk committed Jul 12, 2024
1 parent 0a9d2b3 commit ca8a15c
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions docs/release/trg-1/trg-1-08.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,11 @@ Interface documentation is crucial to interact with components. It fundamentally

## Description

- The interface documentation **should** be stored in the folder `/docs/api` as `openAPI.yaml`
- The interface documentation **should** be either stored in the folder `/docs/api` as `openAPI.yaml` or referenced in the `.tractusx` meta file as reachable document (like GitHub release asset) through the `openApiSpecs` key
- 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
- Alternative the interface documentation **should** be referenced in the .tractusx meta file as reachable document (like GitHub release asset)

## Best Practice

Expand Down

0 comments on commit ca8a15c

Please sign in to comment.