chore(api): OpenAPI 3.0 spec for manager v1 API + spectral CI lint - #67
Merged
Conversation
Authored comprehensive OpenAPI 3.0.3 spec covering all 86 manager API endpoints across 12 blueprint modules (Auth, Users, Teams, Zones, DNS Servers, DHCP, Time, Tokens, IOC Feeds, WHOIS, Analytics, Client Config). Spec includes: - Bearer JWT security scheme with pre-auth exceptions for login/refresh - Complete request/response schemas with proper status codes - Scope-based authorization hints in operation descriptions - All path parameters, query filters, and request bodies documented - Shared Error schema and per-blueprint tags for organization Spectral linting integrated into CI (build.yml) and local lint target (Makefile). Live docs/spec route deferred to Quart migration (auth-gating requires request context not available in Flask). .gitignore updated to track spec and Spectral config files. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Sorry @PenguinzTech, you have reached your weekly rate limit of 500000 diff characters.
Please try again later or upgrade to continue using Sourcery
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
1 participant
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.
OpenAPI 3.0.3 spec for the manager REST API at
openapi/v1.yaml— 86 operations / 58 paths / 12 tags, bearer-JWT security scheme withsecurity: []only on login/refresh, shared Error schema, scope hints per endpoint..spectral.yaml(spectral:oas) with lint wired into the build workflow and Makefile (graceful npx fallback); .gitignore carve-out so the spec survives the repo's broad*.yamlignore. Spectral passes (advisory warnings only). Live authenticated docs route intentionally deferred to the Quart migration per the docs-auth standard.Stack note: bases on
chore/dedup-reusable-code(top of the #53–#59 chain); auto-retargets towardv2.1.xas the stack merges bottom-up.🤖 Generated with Claude Code