platform-api-docs

LoopWright Platform - API - Docs

The published OpenAPI contracts for every platform API, the deprecation record, and the contract site that serves them · Owner group:default/product-engineers · Lifecycle production · System sos-platform · Repository gradera/platform-api-docs

The published OpenAPI contracts for every platform API, and the record of every deprecation. A change to an API lands here in the same change as the code — that is the estate’s rule, not this repository’s preference.

Usage

Swagger UI

Use the following URL in Swagger UI:

https://gradera.github.io/platform-api-docs/sos-admin/v1.yaml

Postman

1. Open Postman
2. Click Import
3. Select Link
4. Paste the following URL:

https://gradera.github.io/platform-api-docs/sos-admin/v1.yaml

Non-obvious commands

docker compose -f compose.lint.yaml up	runs the spec linting CI runs, without installing anything
deprecations.md	every alias and removal, with the release that made it — check here before assuming a field is gone

Where to look next

• Where each spec lives — docs/architecture.md
• Versioning, conventions and contract parity — docs/configuration.md
• Validation — docs/ci-cd.md
• Branches, environments and the contract site — docs/deployment.md