feat: add SAT OpenAPI 3.1 spec#6
Open
dmchaledev wants to merge 1 commit into
Open
Conversation
Adds the missing Security Awareness Training REST API specification, fulfilling the README's content table and enabling the CI workflow's existing sat/openapi.yaml validation step to run. Covers 6 resource groups (Users, Groups, Modules, Campaigns, Enrollments, Reports) with 18 endpoints including phishing campaign lifecycle, training progress tracking, and compliance/phishing aggregate reports. Follows the same conventions as the existing ASM spec: Bearer auth, pagination envelope, shared Error schema, and `prefix_id16` identifier pattern. https://claude.ai/code/session_017zrqLEFs9iNoeaLEmFSRsc
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.yaml— listed in the README contents table and referenced by the existing CI validation workflow, but not yet present in the repoasm/openapi.yaml: Bearer auth, pagination envelope, sharedErrorschema,prefix_id16identifier pattern, and Spectral-compatible OpenAPI 3.1.0What's included
GET/POST /users,GET/PATCH/DELETE /users/{id}GET/POST /groups,GET/PATCH/DELETE /groups/{id}GET /modules,GET /modules/{id}(read-only catalog)GET/POST /campaigns,GET /campaigns/{id},POST …/launch,POST …/cancelGET/POST /enrollments,GET /enrollments/{id}GET /reports/completion,GET /reports/phishingWhy this matters
Without this file the CI workflow silently skips SAT validation (the step is conditional on
hashFiles('sat/openapi.yaml') != ''), and the README's contents table has a broken entry. This PR closes both gaps and gives integrators the reference they need to build against the SAT API.Test plan
Validate OpenAPI Specsworkflow passes forsat/openapi.yamlPOST /usersrequest body matches the Quick Start example in README (email+group_id)https://claude.ai/code/session_017zrqLEFs9iNoeaLEmFSRsc
Generated by Claude Code