Provide convenience method for adding a client-id header
評価
調査の方向性
既存の token メソッドと bearer_token メソッドの隣にある Query クラスから始め、次に python_cmr パッケージのバージョンがどのように公開されているかを確認します。client_id コンビニエンスメソッドが、要求されたデフォルト値またはバージョンサフィックスの動作で Client-Id を設定し、ユーザー指定の ID とデフォルトの ID の両方をカバーできれば完了です。
索引モデルが issue の本文から書いたものです。
説明
The Headers section of the CMR Search API documentation describes the Client-Id header as follows:
Client-Id- Indicates a name for the client using the CMR API. Specifying this helps Operations monitor query performance per client. It can also make it easier for them to identify your requests if you contact them for assistance.
Given that there are token and bearer_token methods in the Query class for conveniently setting the Authorization header, providing a client_id method would be convenient for supplying the Client-Id header.
Further, I recommend the following:
- When the user does not invoke the
client_idmethod to specify their own chosen ID for identification for assistance, a default should be set. I recommend something like this:python_cmr-vX.Y.Z, whereX.Y.Zis the version ofpython_cmr - When the user does invoke the
client_idmethod, the following suffix should be added to the value specified by the user:(python_cmr-vX.Y.Z), with a space character between the user-supplied value and the suffix.
- 主要言語
- Python
- スター
- 29
- フォーク
- 32
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
このプロジェクトの環境構築ファイルはまだ確認していません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
nasa/python_cmr のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
nasa/python_cmr#123 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
nasa/python_cmr#122 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
nasa/python_cmr#108 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 52/100
nasa/python_cmr#104 ·
-
enhancement
難易度 3/5 1〜2日 初心者へのやさしさ 38/100
nasa/python_cmr#95 · コメント 1 件 ·
nasa/python_cmr の issue をすべて見る
似ている issue
-
needs triage
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
openvinotoolkit/openvino_notebooks#3665 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
メンテナーはふだん 1 日以内に返信
-
docs
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
benchmark-gap
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信