Estou desenvolvendo REST API usando quarkus-restimplementação do Jakarta REST (anteriormente conhecido como JAX-RS). Também uso quarkus-smallrye-openapiextensão para gerar minha especificação de API (OpenAPI v3).
Como posso preencher os campos: resumo e descrição de um objeto Path Item usando anotações ou de outra forma (sem escrita manual de especificações)?
Tenho uma API GraphQL descrita de acordo com a especificação de outubro de 2021 .
Tenho um argumento sizeque quero remover.
type Product {
picture(size: Int): Url
}
Mas não posso removê-lo imediatamente sem informar os consumidores na especificação da API. Sei que o rascunho de trabalho da especificação permite usar a diretiva @deprecated com argumentos, mas a especificação de 2021 não permite isso.
Como posso excluir o campo de maneira informada sem violar a especificação de 2021?
Tive a ideia de descontinuar o campo e criar um campo ao lado dele com o mesmo nome, mas sem um argumento, mas infelizmente essa não é uma ação válida.