Skip to content

doc: enhanced the auth route documentation#244

Open
medinasheriff wants to merge 1 commit intohotosm:developfrom
medinasheriff:enhance/user-auth-api
Open

doc: enhanced the auth route documentation#244
medinasheriff wants to merge 1 commit intohotosm:developfrom
medinasheriff:enhance/user-auth-api

Conversation

@medinasheriff
Copy link
Copy Markdown

What type of PR is this?

Documentation enhancement.

Check all applicable

  • 🍕 Feature
  • 🐛 Bug Fix
  • 📝 Documentation
  • 🧑‍💻 Refactor
  • ✅ Test
  • 🤖 Build or CI
  • ❓ Other (please specify)

Related Issue :

What does this PR do ?

This PR enhances the raw data API by explicitly describing the type of HTTPException raised (403) for some of the routes as well as uniformity in the way the result is returned to users. By the /auth/login/ and /auth/callback/

Screenshots :

Screenshot 2024-04-02 at 1 20 41 AM Screenshot 2024-04-02 at 1 20 59 AM Screenshot 2024-04-02 at 1 21 36 AM

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

image

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.

Enhance API documentation and examples

1 participant