docs: fix SAT quick-start example to match the real OpenAPI spec#41
Open
dmchaledev wants to merge 1 commit into
Open
docs: fix SAT quick-start example to match the real OpenAPI spec#41dmchaledev wants to merge 1 commit into
dmchaledev wants to merge 1 commit into
Conversation
The README's "Enroll a User" example posted to a nonexistent
`/sat/v1/users` endpoint with an `{email, group_id}` body — SAT has no
such route or schema. It also implied a shared `api.hailbytes.com`
host, but SAT is self-hosted (openapi server is the relative `/api`).
Replaced it with a real, spec-matching example: adding a target via
`POST /groups/`.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01K3DKc79upGPwzKoHaeLxFd
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.
Summary
The README's SAT quick-start example ("Enroll a User") posted to
https://api.hailbytes.com/sat/v1/userswith a{email, group_id}body.Neither the endpoint, host, nor request body correspond to anything in
sat/openapi.yaml:/usersroute for enrollment —POST /users/is anAdmin-only endpoint for creating system accounts, gated by
modify_systempermission, and doesn't acceptemail/group_id.sat/openapi.yamldeclaresservers: [{url: /api}]— a relative path,because SAT is a self-hosted, open-source platform, not a shared
HailBytes-hosted API like ASM. The README's
api.hailbytes.comhost ismisleading for this API.
Replaced the example with
POST /groups/, which is the real, spec-matchingway to add a target (recipient) to a phishing simulation group, and added a
note clarifying that SAT is self-hosted.
Test plan
POST /groups/and itsGroup/Targetschemas exist insat/openapi.yamland match the new example's request body(
name,targets: [{email, first_name, last_name}]).{email, group_id}example.spectral linton both specs still passes (docs-only change, specsuntouched).
Co-Authored-By: Claude Sonnet 5 noreply@anthropic.com
https://claude.ai/code/session_01K3DKc79upGPwzKoHaeLxFd
Generated by Claude Code