OAuth documentation for GET /api/v2/users/me/ appears inconsistent with required global read scope

未关闭 适合新手
#10,201 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
68/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
活跃
技术栈
typescript
领域
documentation

调研方向

从 Developer Docs → API Reference → v2 → Authentication → Who am I 开始,并比较 GET /api/v2/users/me 的 scope 要求与示例响应。检查端点的行为或其源代码,以确定需要哪些 scope,以及会返回哪些 scope。更新示例响应或添加说明,使示例与要求一致。

由索引模型根据 Issue 内容生成。

描述

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!

主要语言
TypeScript
星标
61.9k
派生
6.3k
平均合并
1 天 18 小时
30 天内合并 PR
74

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

makeplane/plane 的其他 Issue

查看 makeplane/plane 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。