polar icon indicating copy to clipboard operation
polar copied to clipboard

Clarify required scopes documentation

Open frankie567 opened this issue 8 months ago • 0 comments

We had a feedback on Discord wondering why we required both a read and write scope on a read-only operation:

Capture d’écran 2025-03-12 à 08.53.11.png

This should be read as an OR, but it's true that it may be misleading. We probably should improve the wording or presentation here.

Notes

  • The logic responsible for adding scopes to the docstring is inside DocumentedAuthSubjectAPIRoute class.
  • I discovered that we can add JSX component into the docstring and it's correctly interpreted by Mintlify. Maybe there are nice things to do with this.

frankie567 avatar Mar 12 '25 07:03 frankie567