raw-data-api icon indicating copy to clipboard operation
raw-data-api copied to clipboard

doc: enhanced the auth route documentation

Open medinasheriff opened this issue 1 year ago • 0 comments

What type of PR is this?

Documentation enhancement.

Check all applicable

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

Related Issue :

  • Resolve #219

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

medinasheriff avatar Apr 02 '24 00:04 medinasheriff