Skip to content

Commit

Permalink
Update docs/pt/docs/tutorial/schema-extra-example.md
Browse files Browse the repository at this point in the history
Co-authored-by: Jéssica Paz <jessicamorim.42@gmail.com>
  • Loading branch information
luccasmmg and jessicapaz committed Jul 4, 2023
1 parent 3bfd1df commit b9e3eda
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/pt/docs/tutorial/schema-extra-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Por isso, o OpenAPI 3.0.3 definiu o seu próprio <a href="https://github.com/OAI

Portanto, embora `example` não seja parte do JSON Schema, é parte da versão customizada do JSON Schema usada pelo OpenAPI, e é isso que vai ser usado dentro da UI de documentação.

Mas quando você usa `example` ou `examples` com qualquer um dos outros utilitários (`Query ()`, `Body ()`, etc.) esses exemplos não são adicionados ao JSON Schema que descreve esses dados (nem mesmo para versão própria do OpenAPI do JSON Schema), eles são adicionados diretamente à declaração da *operação de rota* no OpenAPI (fora das partes do OpenAPI que usam o JSON Schema).
Mas quando você usa `example` ou `examples` com qualquer um dos outros utilitários (`Query()`, `Body()`, etc.) esses exemplos não são adicionados ao JSON Schema que descreve esses dados (nem mesmo para versão própria do OpenAPI do JSON Schema), eles são adicionados diretamente à declaração da *operação de rota* no OpenAPI (fora das partes do OpenAPI que usam o JSON Schema).

Para `Path()`, `Query()`, `Header()`, e `Cookie()`, o `example` e `examples` são adicionados a <a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#parameter-object" class="external-link" target="_blank">definição do OpenAPI, dentro do `Parameter Object` (na especificação)</a>.

Expand Down

0 comments on commit b9e3eda

Please sign in to comment.