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

オープン 初心者向け
  • 何か問題がありますか？
#10,201 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
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時間
マージ済み PR（30日）
74

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

makeplane/plane のほかの issue

makeplane/plane の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。