Skip to content

[Docs] Improve API documentation for authentication and API key management#30

Merged
Gautam25Raj merged 1 commit into
masterfrom
docs/api-auth-and-openapi-improvements
May 7, 2026
Merged

[Docs] Improve API documentation for authentication and API key management#30
Gautam25Raj merged 1 commit into
masterfrom
docs/api-auth-and-openapi-improvements

Conversation

@Gautam25Raj
Copy link
Copy Markdown
Collaborator

Summary

This PR updates and improves API documentation to better reflect existing authentication and API key management features.


Docs

Authentication Documentation

  • Documented API key authentication flow
  • Added email OTP authentication endpoints:
    • Send OTP
    • Verify OTP

API Key Documentation

  • Added detailed documentation for API key endpoints:
    • List, create, rotate, revoke, and delete
  • Improved response schemas and examples

OpenAPI Improvements

  • Updated OpenAPI spec with clearer structure and definitions
  • Added proper error responses (bad request, not found, etc.)
  • Organized API paths into separate files for better maintainability

Notes

  • No code changes
  • Documentation-only update
  • Improves clarity and developer experience for API usage

Type of Change

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📝 Documentation update
  • 🧪 Tests (adding or updating tests)

Checklist

  • [x I have read the CONTRIBUTING.md document.
  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • My changes generate no new warnings.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.
  • Any dependent changes have been merged and published in downstream modules.

- 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.
@Gautam25Raj Gautam25Raj added the documentation Improvements or additions to documentation label May 7, 2026
@Gautam25Raj Gautam25Raj merged commit 7f9f085 into master May 7, 2026
1 of 2 checks passed
@Gautam25Raj Gautam25Raj deleted the docs/api-auth-and-openapi-improvements branch May 12, 2026 06:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant