feat: add SAT OpenAPI 3.1 specification#8
Open
dmchaledev wants to merge 1 commit into
Open
Conversation
Adds sat/openapi.yaml, the missing half of the API documentation surface called out in the README contents table and Quick Start examples. Covers all core SAT resources — Users, Groups, Campaigns, Simulations, Enrollments, and Reports (compliance + phishing) — following the same conventions as asm/openapi.yaml (pagination envelope, PascalCase $ref parameters, nullable fields, rate-limit headers). CI is already wired to lint this file via spectral:oas once it exists. https://claude.ai/code/session_01XhL2QtZ93S9ZdqUQ5Xz6wP
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— the OpenAPI 3.1 spec for the HailBytes Security Awareness Training API, which is the only file listed in the README contents table and Quick Start section that didn't exist yet.asm/openapi.yaml: pagination envelope, PascalCase$refparameters,nullablefields, rate-limit headers, and consistent ID patterns.validate-openapi.yml) is already wired to lint this file with Spectral once it exists — this PR activates that check.Resources covered (6 tags, ~20 endpoints):
GET/POST /users,GET/PATCH/DELETE /users/{id}GET/POST /groups,GET/PATCH/DELETE /groups/{id}GET/POST /campaigns,GET/PATCH /campaigns/{id}GET/POST /simulations,GET /simulations/{id}GET/POST /enrollmentsGET /reports/compliance,GET /reports/phishingSchemas include summary (
User,Campaign, …) and detail (UserDetail,CampaignDetail,SimulationDetail) variants with read-only aggregate fields (completion rates, phish-prone percentages, click/report rates).Test plan
sat/openapi.yamlwith--fail-severity warn$reftargets resolve (no dangling references)POST /sat/v1/userswithemail+group_id— matches the spec'sUserCreateschemausr_,grp_,cmp_,sim_,enr_) are internally consistent across path parameters, query filters, and schema exampleshttps://claude.ai/code/session_01XhL2QtZ93S9ZdqUQ5Xz6wP
Generated by Claude Code