API - send/receive API version as header
メンテナーはふだん 7 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- 機能追加
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
調査の方向性
まず docs/CALENDAR_API.md のバージョン変更履歴を読んでください。リクエストとレスポンスがメジャーバージョンを使用するか、サポートされていないバージョンにどのステータスコードを適用するか、またサーバーがデフォルトで最新バージョンを使用するかどうかを明確にしてください。v1 と v2 の proof of concept によって、合意されたバージョンネゴシエーションの動作が文書化および実装されれば完了です。
索引モデルが issue の本文から書いたものです。
説明
The API should include the version number as a header in responses, e.g.
API-Version: 3
(Major version number only?)
Clients would also be encouraged (though not required) to include the version they're using in requests. If the client doesn't specify, the server would assume the latest version. In the future we may rev the version and introduce breaking changes, so clients should send the version they're expecting to ensure a predictable response.
As a proof of concept for handling different versions, we could check for v1 or v2 requests and reject those. (There should be no real requests for those versions, because those version numbers were defined post-hoc well after we were already on v3.) Error status code could be 400, or possibly 406 (Not Acceptable).
- 主要言語
- JavaScript
- スター
- 30
- フォーク
- 26
- 平均マージ
- 6日 23時間
- マージ済み PR（30日）
- 3
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートなし
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
shift-org/shift-docs のほかの issue
-
Unknown --db values report a TypeError instead of the intended error対応中かも @gangster が 70 日前に担当しました。 オープン
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
shift-org/shift-docs#1091 ·
メンテナーはふだん 7 日以内に返信
-
validateRideLength accepts any Object.prototype key as a ride length対応中かも @gangster が 70 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
shift-org/shift-docs#1089 ·
メンテナーはふだん 7 日以内に返信
-
Favorites page fetches every favorite because getDaily's guard is inverted対応中かも @gangster が 70 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
shift-org/shift-docs#1087 ·
メンテナーはふだん 7 日以内に返信
-
sitemap.xml emits relative <loc> values, so search engines reject it対応中かも @dduugg が 96 日前に担当しました。 オープン
難易度 4/5 3〜5日 初心者へのやさしさ 68/100
shift-org/shift-docs#1082 ·
メンテナーはふだん 7 日以内に返信
-
難易度 3/5 1〜2日 初心者へのやさしさ 58/100
shift-org/shift-docs#1072 ·
メンテナーはふだん 7 日以内に返信
shift-org/shift-docs の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
woocommerce/woocommerce-google-analytics-integration#699 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
t0ggles
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
nolimits4web/swiper#8240 · コメント 1 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
Inter-Actief/amelink#131 ·