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

Enhance/raw-data-api #226

Closed
wants to merge 10 commits into from
Closed

Conversation

nifedara
Copy link

What does this PR do?

Enhances documentation quality

  • Adds API description
  • Adds 403, 404, and 500 responses to Auth endpoints
  • Adds example for 403 response in Auth endpoints
  • Adds Error message model
  • Removes trailing slashes from Auth endpoints
  • Contributes to solving this issue: (Enhance API documentation and examples #219)

Consideration?

  • Having responses and examples defined helps consumers handle errors better
  • It is also recommended for API security that response schemas be used hence why there is a model for Error message
  • Removing the trailing slashes is good practice that ensures consistency in the endpoints

How to test?

Follow Docker Installation Guide
To shoot the server up and view the Documentation change on your localhost

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

Successfully merging this pull request may close these issues.

1 participant