API responses are getting muddy
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 20/100
- issue の種類
- 機能追加
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- javascript
- 領域
- api
調査の方向性
この issue では、ファイル、エントリポイント、テストが指定されていません。まず API リクエストハンドラーとレスポンスの構築箇所を特定し、次に既存のレスポンス形式と後方互換性の要件を文書化します。完了とは、提案された形式をカバーするレスポンス選択設計について合意されていることを意味します。
索引モデルが issue の本文から書いたものです。
説明
We need to consider better requests to offer the cleaner responses. We've made some compromises for backward compatibility but not in a generic way. It may be good to find that way. One option would be something like ?responseContainer=new_obj on the request so that we can default to returning the updated document or an array of them or put them inside { queryResults: [ results ] } if the consuming application needs/prefers them that way.
This would mean we would only have to modify old requests to add the parameter and we would be accommodating future requests like metadata if someone wants back the original query, count of results, time to find, most recent, ordering, etc.
- 主要言語
- JavaScript
- スター
- 3
- フォーク
- 6
- 平均マージ
- 14分
- マージ済み PR（30日）
- 2
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
CenterForDigitalHumanities/rerum_server_nodejs のほかの issue
-
bug documentation
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
-
backend dependencies easy
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
CenterForDigitalHumanities/rerum_server_nodejs#290 · コメント 1 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 50/100
-
難易度 3/5 1〜2日 初心者へのやさしさ 74/100
CenterForDigitalHumanities/rerum_server_nodejs の issue をすべて見る
似ている issue
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
fossasia/scrum_helper#949 ·
メンテナーはふだん 2 日以内に返信
-
Learn Faust tutorial: Blocks step says Faust loads block CSS, but no WordPress styles are appliedオープン[Type] Bug Needs Triage
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
TheOdinProject/curriculum#31493 ·
メンテナーはふだん 1 日以内に返信
-
[Report] Some official plugins are marked as Stable, but their Readme says they are experimentalオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
TiddlyWiki/TiddlyWiki5#10061 ·
メンテナーはふだん 1 日以内に返信
-
documentation ready
難易度 1/5 1〜3時間 初心者へのやさしさ 76/100
メンテナーはふだん 1 日以内に返信