Estou tentando usar o tipo anulável em meu exemplo seguinte de mson na documentação, mas falha com erro de semântica.
Ajude-me a descobrir o que há de errado com meu mson e como fazer a documentação correta para meu caso de uso.
Obrigado!
Olá @danilvalov , Apiary não está usando a versão mais recente do API Blueprint Parser, que adiciona suporte para anulação.
O Apiary tem uma versão beta para melhorar a renderização de atributos, que inclui suporte para anulação. Você pode encontrar mais sobre o beta em https://github.com/apiaryio/api-blueprint/issues/191#issuecomment -178044764 junto com como ingressar nele.
Cumprimentos,
Kyle
Eu só quero salientar que isso agora foi implantado no Apiary (sem uma versão beta).
Como exemplo, você pode usar nullable como o seguinte:
+ Response 200 (application/json)
+ Attributes
+ example1 (string, optional, nullable) - An example optional nullable string
+ example2: value (string, optional, nullable) - An example optional nullable string with a sample value
Onde isso resultaria em um exemplo de carga útil do seguinte:
{
"example1": null,
"example2": "value"
}
Junto com o seguinte esquema JSON:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"example1": {
"type": [
"string",
"null"
],
"description": "An example optional nullable string"
},
"example2": {
"type": [
"string",
"null"
],
"description": "An example optional nullable string with a sample value"
}
}
}
A tabela de atributos do Apiário ainda não menciona que o valor é anulável , mas isso está chegando.
Isso agora está visível, no ApiaryUI :
Comentários muito úteis
Eu só quero salientar que isso agora foi implantado no Apiary (sem uma versão beta).
Como exemplo, você pode usar nullable como o seguinte:
Onde isso resultaria em um exemplo de carga útil do seguinte:
Junto com o seguinte esquema JSON:
A tabela de atributos do Apiário ainda não menciona que o valor é anulável , mas isso está chegando.