Redocly/redoc

Type: Array and nullable: true does not render nullable

Open

#1.155 aberto em 9 de jan. de 2020

Ver no GitHub
 (1 comment) (1 reaction) (0 assignees)TypeScript (2.272 forks)batch import
Type: Bughelp wanted

Métricas do repositório

Stars
 (21.877 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

I have a response which either returns an array or null. I specify the return json schema with:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "array",
    "uniqueItems": true,
    "items": {
      ....
    }
  "nullable": true
}

But redoc does not render this like for other types e.g. integers.

I currently use the following workaround:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "oneOf": [
    {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "$ref": "../shared/id.json#"
      }
    },
    {
      "type": "any"
      "nullable":true
    }
  ]
}

grafik

Guia do colaborador

Direção de pesquisa
Investigue como o Redoc renderiza nullable para tipos não array (ex.: inteiros) examinando o código fonte, provavelmente no componente Schema. O problema mostra que nullable: true não é aplicado quando o tipo é array. Procure onde a anotação nullable é adicionada à saída renderizada e garanta que ela lida com o tipo array. A solução alternativa usando oneOf sugere que a lógica de renderização pode não verificar nullable para arrays. Consulte a issue #1155 e quaisquer comentários de código relacionados.
Pilha de tecnologia
typescript
Domain
documentation
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
TypeScriptJSON Schema
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75