[Docs] Improve API documentation for authentication and API key management#30
Merged
Merged
Conversation
- Updated OpenAPI specification to include detailed authentication methods: API Key and Session Authentication. - Added new endpoints for email OTP authentication: send OTP and verify OTP. - Introduced API key management endpoints: list, create, rotate, revoke, and delete API keys. - Improved response schemas for API key operations and added error handling for bad requests and not found errors. - Secured various endpoints with API Key authentication alongside existing session-based methods. - Organized paths into separate files for better maintainability and clarity.
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
This PR updates and improves API documentation to better reflect existing authentication and API key management features.
Docs
Authentication Documentation
API Key Documentation
OpenAPI Improvements
Notes
Type of Change
Checklist