docs: sync SAT OpenAPI spec into api-docs and repair spec-lint CI#27
Merged
Conversation
Bring the documentation repo up to date with the canonical API specs
maintained in the source repositories:
- Add sat/openapi.yaml, copied verbatim from hailbytes-sat's canonical
docs/openapi.yaml (33 paths / 52 operations / 27 schemas). The repo was
previously missing the SAT spec entirely (README marked it "coming soon").
- Render both ASM and SAT references on the GitHub Pages site via a tab
switcher in docs/index.html (Redoc.init), and publish sat-openapi.yaml
from the deploy workflow.
- Repair validate-openapi.yml: `--ruleset spectral:oas` is not a valid
reference in spectral-cli 6.x, so the lint job had been erroring on every
run ("Could not read ruleset"). Add a committed .spectral.yaml that
extends spectral:oas and gate at --fail-severity error, mirroring the
hailbytes-sat repo's lint policy (warnings advisory; the SAT API's
intentional trailing-slash paths trip an advisory rule but are correct).
- Add descriptions to the ASM listTags/createTag operations, clearing the
only two remaining advisories on that spec.
ASM has no committed OpenAPI document to sync from — its API is served live
via drf_yasg swagger and the curated asm/openapi.yaml is itself the public
source of truth, so it only needed the lint-driven touch-ups above.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XhcxNP5sPjDwqE5Au8sXYK
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Bring the documentation repo up to date with the canonical API specs
maintained in the source repositories:
docs/openapi.yaml (33 paths / 52 operations / 27 schemas). The repo was
previously missing the SAT spec entirely (README marked it "coming soon").
switcher in docs/index.html (Redoc.init), and publish sat-openapi.yaml
from the deploy workflow.
--ruleset spectral:oasis not a validreference in spectral-cli 6.x, so the lint job had been erroring on every
run ("Could not read ruleset"). Add a committed .spectral.yaml that
extends spectral:oas and gate at --fail-severity error, mirroring the
hailbytes-sat repo's lint policy (warnings advisory; the SAT API's
intentional trailing-slash paths trip an advisory rule but are correct).
only two remaining advisories on that spec.
ASM has no committed OpenAPI document to sync from — its API is served live
via drf_yasg swagger and the curated asm/openapi.yaml is itself the public
source of truth, so it only needed the lint-driven touch-ups above.
Co-Authored-By: Claude Opus 4.8 noreply@anthropic.com
Claude-Session: https://claude.ai/code/session_01XhcxNP5sPjDwqE5Au8sXYK