OAuth documentation for GET /api/v2/users/me/ appears inconsistent with required global read scope
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- typescript
- Domain
- documentation
Research direction
Start at Developer Docs → API Reference → v2 → Authentication → Who am I, and compare the GET /api/v2/users/me scope requirement with the example response. Check the endpoint behavior or its source to establish which scopes are required and which are returned. Update the sample response or add an explanation so the example and requirement agree.
Written by the indexing model from the issue text.
Description
Page:
Developer Docs → API Reference → v2 → Authentication → Who am I
Problem
The documentation states:
"An OAuth token needs the global read scope; a token with only fine-grained scopes such as projects.states:read cannot call it."
However, the example response for the endpoint shows:
"principal_kind": "oauth",
"scopes": [
"projects.work_items:read",
"projects.states:read"
]
These are only fine-grained scopes, which seems to contradict the statement above.
Question
If GET /api/v2/users/me requires the global read scope, why does the sample response show only fine-grained scopes?
Is this:
an incorrect example response,
expected behavior that needs additional explanation?
Suggested improvement
Either:
Update the sample response to include the required global read scope, or
Add a note explaining why the response displays only fine-grained scopes even though the endpoint requires the global read scope.
Thank you!
- Dominant language
- TypeScript
- Stars
- 61.9k
- Forks
- 6.3k
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 74
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from makeplane/plane
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Missing optional chaining on actor_details and reaction_items in apps/space reactions and votesPossibly taken @ghazy2001 claimed this 6 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
makeplane/plane#10111 · 2 comments ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
makeplane/plane#10082 · 1 comment ·
Maintainers usually reply within 1 day
-
[bug]: Email notifications show a broken avatar for users without a profile photoPossibly taken @gurnoorpannu claimed this 21 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
makeplane/plane#10009 · 1 comment ·
Maintainers usually reply within 1 day
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
Maintainers usually reply within 2 days
-
reproduced
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
anomalyco/opencode#62052 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
strapi/design-system#2084 ·
Maintainers usually reply within 3 days
-
check:passed streams:remove
Difficulty 1/5 Under an hour Newbie friendliness 67/100
Maintainers usually reply within 1 day
-
bug priority-p1
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day