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/user-auth-api #2

Open
wants to merge 21 commits into
base: develop
Choose a base branch
from
Open

Enhance/user-auth-api #2

wants to merge 21 commits into from

Conversation

KafayatYusuf
Copy link
Owner

@KafayatYusuf KafayatYusuf commented Apr 4, 2024

What type of PR is this?

Check all applicable

  • πŸ• Feature
  • πŸ› Bug Fix
  • πŸ“ Documentation
  • πŸ§‘β€πŸ’» Refactor
  • βœ… Test
  • πŸ€– Build or CI
  • ❓ Other (please specify)

Related Issue :

  • Corrects grammatical errors and punctuation in the markdown
  • Removes trailing backslashes

What does this PR do ?

Improves the documentation quality of the auth endpoint by introducing the followings:

  • Removes trailing slashes
  • Import error module to manage errors
  • Added status code responses
  • Added security feature

Consideration :

  • Removing trailing backslashes help to keep a consistent format and avoid errors
  • Status response codes help user to identify and know the responses to expect

How to test?

Clone this repository
Install and Configure Docker with this link Docker Installation Guide
Visit the link below to access the API documentation
Raw Data API Documentation

Screenshots :

image

Checklists:

Checklist before requesting review :

  • πŸ“– Read the HOT Code of Conduct: https://docs.hotosm.org/code-of-conduct
  • πŸ‘·β€β™€οΈ Create small PRs. In most cases, this will be possible.
  • βœ… Provide tests for your changes.
  • πŸ“ Use descriptive commit messages.
  • πŸ“— Update any related documentation and include any relevant screenshots.

[optional] What gif best describes this PR or how it makes you feel?

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