Skip to content

docs: Adopt TRG 1.08 interface documentation apis#85

Merged
CDiezRodriguez merged 18 commits intomainfrom
docs/adopt-trg-108-interface-documentation-apis
Sep 24, 2025
Merged

docs: Adopt TRG 1.08 interface documentation apis#85
CDiezRodriguez merged 18 commits intomainfrom
docs/adopt-trg-108-interface-documentation-apis

Conversation

@CDiezRodriguez
Copy link
Copy Markdown
Contributor

WHAT

This PR adds the upstream OpenAPI specification for the API by uploading the corresponding Bruno collection and OpenAPI definition files. The API documentation is now included in the /docs/api.

WHY

This change was necessary to comply with TRG 1.08 – Interface Documentation (APIs) from the Eclipse Tractus-X Release Guidelines. It ensures that the API is discoverable, well-documented, and aligned with interoperability and release requirements.

FURTHER NOTES

Closes #74

@CDiezRodriguez CDiezRodriguez self-assigned this Jun 20, 2025
@CDiezRodriguez CDiezRodriguez changed the title docs: Adopt trg 108 interface documentation apis docs: Adopt TRG 1.08 interface documentation apis Jun 20, 2025
Copy link
Copy Markdown

@github-advanced-security github-advanced-security AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

KICS found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.

@github-actions
Copy link
Copy Markdown

This pull request is stale because it has been open for 7 days with no activity.

@github-actions github-actions bot added the stale label Jun 28, 2025
@CDiezRodriguez CDiezRodriguez added documentation Improvements or additions to documentation and removed stale labels Jun 30, 2025
@matbmoser
Copy link
Copy Markdown
Contributor

DCP endpoints are failing, because they dont work with the STS.

@matbmoser matbmoser requested a review from nitin-vavdiya July 30, 2025 13:44
@mgarciaLKS mgarciaLKS self-requested a review September 2, 2025 09:54
@CDiezRodriguez CDiezRodriguez marked this pull request as ready for review September 15, 2025 09:40
Copy link
Copy Markdown
Contributor

@matbmoser matbmoser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚔️ Hear ye, hear ye! @CDiezRodriguez

By my honor and upon thorough review of thy noble labors, I, humble knight and guardian of this codebase, do proclaim this Pull Request most righteous and worthy of merging into the Great Repository.

Thy logic is as sound as tempered steel, thy syntax as elegant as a bard’s song, and no blemish nor flaw did I uncover upon the field of diff. Verily, this contribution shall strengthen our kingdom’s foundations and endure the test of time.

Thus, with solemn oath and knightly seal, I grant thee my full and unwavering approval.
Merge forth, brave champion! ⚔️👑

@CDiezRodriguez CDiezRodriguez merged commit 7bdafad into main Sep 24, 2025
28 of 30 checks passed
@CDiezRodriguez CDiezRodriguez deleted the docs/adopt-trg-108-interface-documentation-apis branch September 24, 2025 13:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Adopt TRG 1.08 – Interface Documentation (APIs)

3 participants