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.

Sign up for GitHub

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

Jump to bottom

Clarify required scopes documentation #5251

Open
frankie567 opened this issue Mar 12, 2025 — with Linear · 0 comments
Open

Clarify required scopes documentation #5251

frankie567 opened this issue Mar 12, 2025 — with Linear · 0 comments
Labels
docs

Comments

@frankie567 Linear
Copy link
Member

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 frankie567 added the docs label Mar 12, 2025 — with Linear
@github-project-automation github-project-automation bot moved this to Backlog in Backlog Mar 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs
Projects
Backlog
Status: Backlog
Polar
Status: No status
Milestone
No milestone
Development

No branches or pull requests
1 participant
@frankie567