[OpenAPI 3.1] Phase 3: wire the converter in

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

Mantenedores costumam responder em até 5 dias

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
4/5
Tempo estimado
3-5 dias
Facilidade para iniciantes
35/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
java, openapi
Domínio
api, tooling

Direção de pesquisa

Start from the plan in #942 and the converter landed in Phase 2, then trace every caller of OpenApiDiff.compare() and fromSpecifications to see where copies must be made before conversion. The 3.0-shape reads and the temporary both-shapes branches from Phase 2 need removing, and the renderers must be updated so a multi-type prints as string | null. Run the 3.0-to-3.1 cross-version tests, including the specs from #755 and #858, add a test proving fromSpecifications leaves its arguments untouched, and draft the 3.0.0 migration notes covering result schemas, the --json shape and removed APIs.

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

Descrição

OpenAPI 3.1.0 Support

Part of the OpenAPI 3.1 plan: #942 (Stage 1, Phase 3)

Goal

Every spec is converted to 3.1 before comparing. Results contain the 3.1 form.

Scope
  • Call the converter in OpenApiDiff.compare(); fromSpecifications works on copies
  • Remove the 3.0-shape reads and the temporary both-shapes code from Phase 2
  • Renderers read 3.1 fields; multiple types print as string | null
  • Write the 3.0.0 migration notes: result schemas are 3.1 objects, --json shape, removed or changed APIs
Done when
  • 3.0→3.1 cross-version tests pass, including the specs from #755 and #858
  • fromSpecifications doesn't modify the objects passed in (test)
  • Migration notes drafted
Linguagem predominante
Java
Estrelas
1.1k
Forks
191
Merge médio
4d 23h
PRs com merge (30d)
1

Preparar o ambiente

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 OpenAPITools/openapi-diff

Todas as issues de OpenAPITools/openapi-diff

Issues semelhantes

Mais issues de Java

Receba novas issues na sua caixa de entrada

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