Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(credit-usage-api): add new endpoint documentation for credit usage #1003

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

RutamBhagat
Copy link
Contributor

Fixes: #1000

Add credit usage API docs

This PR adds docs for the /credit-usage endpoint to the v1-openapi.json file. The docs includes:

  • Endpoint definition with GET method.
  • Bearer authentication requirement.
  • Success response schema with remaining credits.
  • Error responses for 404 and 500 status codes.

This change makes sure that the API docs reflect the functionality of the credit usage endpoint

@RutamBhagat
Copy link
Contributor Author

Hey @nickscamara ,

I've updated v1-openapi.json to include the credit usage endpoint, specifically documenting the GET /credit-usage path, its response schema, and error handling.

Please confirm if these OpenAPI changes are sufficient or if you'd like me to update anyy other documentation files to reflect this new endpoint.

The GitHub issue was a bit ambiguous, as it only included the title and no further description.

@nickscamara
Copy link
Member

That's great @RutamBhagat! Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add credit usage API to the docs
2 participants