docs: complete OpenAPI specs for auth and API services #349
+2,122
−112
Conversation
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
- Add comprehensive OpenAPI 3.0.3 spec for auth service - Documents all endpoints: /users, /logins, /sessions, /clients, /credentials, /vaults, /root/authenticate - Includes error response schemas with Campus envelope format - WWW-Authenticate header for 401 responses - Update API OpenAPI spec with all endpoints - /assignments: CRUD operations, classroom links - /circles: CRUD operations, member management - /submissions: CRUD operations, grade updates - /emailotp: request and verify OTP - Error response schemas follow Campus envelope format with OAuth details in nested dict Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Fix duplicate 'credentials' key in auth OpenAPI spec (credential + credentials)
- Fix duplicate /circles/{circle_id}/members path in API OpenAPI spec
(combined GET and PATCH under single path definition)
- Remove nested 'responses:' block from API schemas (non-standard)
- Restore auth-error-spec.md from git history (was incorrectly removed)
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add openapi-spec-validator to dev dependencies - Fix API OpenAPI spec: - Convert nullable types from JSON Schema array syntax to OpenAPI 3.0 nullable: true - Move response objects from components.schemas to components.responses - Fix response reference names (Unauthorized -> UnauthorizedResponse, etc.) - Add unit tests for OpenAPI spec validation in tests/unit/common/test_openapi_spec.py - Tests validate YAML syntax and OpenAPI 3.0.3 compliance - Focus on structural validity to minimize maintenance - Update TESTING-GUIDE.md with OpenAPI validation commands Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Closed
Contributor
|
Fix #31 |
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
Auth Service OpenAPI Spec
Documents all endpoints:
/users- CRUD operations, activate/logins- Create login session with email/password/sessions/{provider}- OAuth session creation (Google, Microsoft)/clients- OAuth client registration/credentials/{provider}/{user_id}- CRUD for credentials/vaults/{label}/{key}- Vault key management/root/authenticate- Internal service authenticationError response schemas include:
details.oauth_errorWWW-Authenticateheader for 401 responsesReference: auth-error-spec.md
API Service OpenAPI Spec
Documents all endpoints:
/assignments- CRUD operations, classroom links/circles- CRUD operations, member management (add, remove, update access)/submissions- CRUD operations, response/feedback management, grade updates/emailotp- Request and verify OTPError response schemas follow Campus envelope format with field-level validation errors.
🤖 Generated with Claude Code