document design principle around nullability
オープン
@darrelmiller がすでに取り組んでいます。
2023年8月25日 から。
評価
この issue はまだ評価されていません。
説明
We keep getting questions about nullability when we project the client.
We should document the facts that:
- we project a nullable return type for the root of the response, even if the description doesn't say it's nullable. This is so the client can survive change in service behaviour without being refreshed. (e.g. the service starts returning 204)
- we project properties on models as nullable. This is to account for services that allow selection/projection via query parameters where the returned payload might omit described properties.
- we project request bodies as nullable or not depending on the required property in the description
- 主要言語
- 言語のデータがありません
- スター
- 22
- フォーク
- 50
- 平均マージ
- 4日 8時間
- マージ済み PR（30日）
- 3
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
MicrosoftDocs/openapi-docs のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 35/100
MicrosoftDocs/openapi-docs#151 ·
-
adds java example to middleware documentation page再び着手できるかも @Ndiritu が 685 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
MicrosoftDocs/openapi-docs#138 · 担当者 1 名 ·
-
adds python example to middleware documentation page再び着手できるかも @Ndiritu が 685 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
MicrosoftDocs/openapi-docs#137 · コメント 1 件 · 担当者 1 名 ·
-
adds php example to middleware documentation page再び着手できるかも @Ndiritu が 685 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
MicrosoftDocs/openapi-docs#136 · 担当者 1 名 ·
-
adds Go example to middleware documentation page再び着手できるかも @rkodev が 684 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
MicrosoftDocs/openapi-docs#135 · 担当者 1 名 ·