OpenAPI docs: identityname should be identity.name, and token scope admin should be global
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 78/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- csharp, openapi
- 領域
- api, documentation
調査の方向性
src/Exceptionless.Web/Api/Endpoints/EventEndpoints.cs のパラメーターの説明と TokenEndpoints.cs のトークンスコープの説明を読み、EventHandler.cs および AuthorizationRoles.cs と比較してください。OpenAPI の説明を更新して identity.name を使い、client、user、global、source-maps:write を列挙し、tests/Exceptionless.Tests/Api/Data/openapi.json のスナップショットを再生成してください。説明とチェックイン済みのスナップショットがサーバーの動作と一致すれば完了です。
索引モデルが issue の本文から書いたものです。
説明
The generated OpenAPI document has two errors that make API calls fail or behave unexpectedly:
- The event submit GET endpoints document an
identitynamequery parameter. The server readsidentity.name. - The token create endpoints say valid scopes are
client, user, admin. The scope is actually namedglobal, andadminis rejected.
Where
identitynamedescriptions: EventEndpoints.cs#L610, #L650, #L682, #L715, #L923- Server parsing: EventHandler.cs#L504-L509
- Scope descriptions: TokenEndpoints.cs#L101, #L122, #L146
- Actual scope names: AuthorizationRoles.cs#L10, #L24; validation in TokenHandler.cs#L222-L244
- Checked-in snapshot: openapi.json#L735, #L906, #L2179, #L2324, #L2633
What happens
GET /api/v2/events/submit?...&[email protected]&identityname=Janestoresidentitynameas a custom data property, and the user's name isn't set.- Creating a token with
"scopes": ["admin"]returns a validation error, "Invalid token scope requested."
Expected
The parameter is documented as identity.name, and the scope descriptions list client, user, global (global admins only), and source-maps:write.
Suggested fix
Rename the parameter key and description in EventEndpoints.cs, fix the three token descriptions, and regenerate openapi.json. Optionally accept identityname as an alias in EventHandler for clients that followed the docs.
- 主要言語
- C#
- スター
- 2.5k
- フォーク
- 508
- 平均マージ
- 2日 17時間
- マージ済み PR（30日）
- 40
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
exceptionless/Exceptionless のほかの issue
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
exceptionless/Exceptionless#2706 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
exceptionless/Exceptionless#2705 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
exceptionless/Exceptionless#2704 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 73/100
exceptionless/Exceptionless#2703 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100
exceptionless/Exceptionless#2701 ·
メンテナーはふだん 1 日以内に返信
exceptionless/Exceptionless の issue をすべて見る
似ている issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
メンテナーはふだん 1 日以内に返信
-
bug mac アプリ: コード アプリ: チャット 優先: 中 要トリアージ
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
yksr-melt/Meltype#1346 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
Collect corrected translations in the app, with no GitHub account and the least possible frictionオープンlocalization medium ui
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
hexide-io/HexIDE#2819 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100