fix(readme): correct OpenAPI version badge and SAT quick-start example#30
Open
dmchaledev wants to merge 1 commit into
Open
fix(readme): correct OpenAPI version badge and SAT quick-start example#30dmchaledev wants to merge 1 commit into
dmchaledev wants to merge 1 commit into
Conversation
- Badge and prose incorrectly stated OpenAPI 3.1 for both specs; SAT uses OpenAPI 3.0.3. Updated badge to 3.0/3.1 and prose to list both. - The "SAT — Enroll a User" example called POST /sat/v1/users with an enrollment body, but /users/ is the admin user-management endpoint (requires modify_system permission), not campaign enrollment. Replaced with a correct GET /api/campaigns/ call that matches the spec.
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
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.
Summary
sat/openapi.yamldeclaresopenapi: 3.0.3. Updated the badge to3.0/3.1and the prose to list each spec's version explicitly.POST /sat/v1/userswith a body of{"email": ..., "group_id": ...}. In the spec,POST /users/is the admin user-management endpoint (requiresmodify_systempermission) — it creates system users, not campaign targets. Replaced it with a correctGET /api/campaigns/call (returns the authenticated user's campaigns, no special permissions required) and updated the section title accordingly.Changes
README.mdonly — no spec or CI changes.OpenAPI 3.1OpenAPI 3.0/3.1OpenAPI 3.0 spec for the SAT REST APIOpenAPI 3.0.3 spec for the SAT REST APIPOST /sat/v1/userswith enrollment bodyGET /api/campaigns/Test plan
sat/openapi.yaml(GET /campaigns/at line 625)Generated by Claude Code