Support for nullable types in OAS 3.1

Aberta
#175 2 comentários 2 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
42/100
Tipo de issue
Bug
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
typescript

Direção de pesquisa

Start with the OpenAPI 3.1 schema example in the issue and trace the type-generation path that turns type: [string, "null"] into void. Check the linked OAS nullable reference, then add coverage showing that the generated foo type represents the nullable schema instead of void.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

The JSON Schema spec supports multiple values for types which allows a property to be nullable.
e.g.

type: object
properties:
  foo:
    type: [string, "null"]

When generating types with this openapi-codegen it results in a void type.

export type Thing = {
  foo?: void;
}

I realise this is differnt from OAS 3.0 where there was a separate nullable property. Does this lib support OAS 3.1?


Reference to the nullable support in OAS 3.1
https://github.com/OAI/OpenAPI-Specification/issues/2244#issuecomment-899084964

Linguagem predominante
TypeScript
Estrelas
635
Forks
82
Merge médio
10d 21h
PRs com merge (30d)
2

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de fabien0102/openapi-codegen

Todas as issues de fabien0102/openapi-codegen

Issues semelhantes

Mais issues de TypeScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.