Quando eu crio um novo tipo de dados (esquemas sob componentes), ele não adiciona type:object
à definição do esquema
Para sua informação - eu consertei isso na biblioteca oai-ts-commands
, então, da próxima vez que um lançamento disso for feito, isso será abordado.
Isso foi corrigido e confirmado - deve estar tudo pronto para a próxima versão.
Obrigado pelo relatório de erro!
@EricWittmann vejo que o problema ainda está aqui, pelo menos algo muito semelhante, para as respostas. Não deveria ser capaz de escolher o tipo de dados "objeto" aqui?
No momento, o apicurio não oferece suporte para definições de objetos inline. Portanto, você precisaria criar um tipo de dados global e, em seguida, referir-se a ele no tipo de mídia application/json
em sua captura de tela. Eu gostaria de oferecer suporte à edição de um tipo object
in-line na resposta, mas ainda não está feito.
Alguma atualização sobre este problema? É a última coisa que preciso antes de reescrever _toda_ minha documentação usando esta ferramenta :)
De qual aspecto desse problema você precisa? Você está se referindo às definições de objetos embutidos? Em caso afirmativo, por que as definições reutilizáveis não são uma alternativa aceitável? Adoraria saber o caso de uso para que possa influenciar a prioridade do recurso.
@EricWittmann
já temos documentação escrita em OpenAPI manualmente ou por outras ferramentas que gostaríamos de reutilizar. A definição de objeto inline é um recurso comum, pelo menos eu me sinto assim e é necessária para compatibilidade com outras ferramentas.
O segundo problema é que, seguindo seu conselho, rapidamente temos muitas definições de objetos que são, em realidade, apenas definições usadas uma vez. é tornar a lista de definições muito longa e desvia a atenção de estruturas realmente úteis e comumente usadas em nossas ápis. por exemplo, em vez de ter
apenas User
e ShopItem
defs comuns, terminando com muitos tipos menos importantes: ResponseXType
, ResponseYType ,
ResponseZType` etc.
OK, obrigado pelo feedback, @psychowico - vou abrir uma nova solicitação de recurso para adicionar melhor suporte para esquemas embutidos. Eu acho que seus motivos para querer esse recurso são bons. :)
Basta consultar sua solicitação de novo recurso, caso alguém esteja procurando por ele: https://github.com/Apicurio/apicurio-studio/issues/744
Comentários muito úteis
No momento, o apicurio não oferece suporte para definições de objetos inline. Portanto, você precisaria criar um tipo de dados global e, em seguida, referir-se a ele no tipo de mídia
application/json
em sua captura de tela. Eu gostaria de oferecer suporte à edição de um tipoobject
in-line na resposta, mas ainda não está feito.