document design principle around nullability
Aberta
@darrelmiller já está trabalhando nisso.
Desde 25/8/2023.
Avaliação
Esta issue ainda não foi avaliada.
Descrição
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
- Linguagem predominante
- Sem dados de linguagem
- Estrelas
- 22
- Forks
- 50
- Merge médio
- 5d 3h
- PRs com merge (30d)
- 3
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Sem modelo de pull request
- Ler o guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de MicrosoftDocs/openapi-docs
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 35/100
MicrosoftDocs/openapi-docs#151 ·
-
adds java example to middleware documentation pageTalvez livre de novo @Ndiritu assumiu há 681 dias e não há nenhum pull request aberto. Aberta
MicrosoftDocs/openapi-docs#138 · 1 responsável ·
-
adds python example to middleware documentation pageTalvez livre de novo @Ndiritu assumiu há 681 dias e não há nenhum pull request aberto. Aberta
MicrosoftDocs/openapi-docs#137 · 1 comentário · 1 responsável ·
-
adds php example to middleware documentation pageTalvez livre de novo @Ndiritu assumiu há 681 dias e não há nenhum pull request aberto. Aberta
MicrosoftDocs/openapi-docs#136 · 1 responsável ·
-
adds Go example to middleware documentation pageTalvez livre de novo @rkodev assumiu há 681 dias e não há nenhum pull request aberto. Aberta
MicrosoftDocs/openapi-docs#135 · 1 responsável ·