feat: document API-key auth, audit pipeline, and GraphQL hardening#71
Merged
feat: document API-key auth, audit pipeline, and GraphQL hardening#71
Conversation
- New api-security.md: unified guide covering API-key auth via the ApiKeyBuilder surface, pre-hashed production pattern, subscription auth over WebSocket connection_init, per-train authorization, GraphQL hardening defaults (depth, cost, introspection gating, operation cap), the audit pipeline, and operational hygiene. - SDK reference pages for api-auth: AddTraxApiKeyAuth (builder and generic overloads, TraxPrincipal, ITraxPrincipalResolver, injecting TraxPrincipal). - SDK reference pages for api-audit: AddAudit, TraxAuditEntry, ITraxAuditSink, TraxAuditOptions. - Updates to authorization, api, and add-trax-graphql pages to reflect new hardening options and per-train authorization behavior.
2 tasks
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.
Summary
api-security.md: unified guide covering API-key auth via theApiKeyBuildersurface, pre-hashed production pattern, subscription auth over WebSocketconnection_init, per-train authorization, GraphQL hardening defaults (depth, cost, introspection gating, operation cap), the audit pipeline, and operational hygiene.api-auth:AddTraxApiKeyAuth(builder + generic overloads),TraxPrincipal,ITraxPrincipalResolver,Injecting TraxPrincipal,TraxAuthClaimTypes.api-audit:AddAudit,TraxAuditEntry,ITraxAuditSink,TraxAuditOptions.authorization,api, andadd-trax-graphqlpages to reflect new hardening options and per-train authorization behavior.Depends on
Test plan
/docs/...paths)