[OpenAPI 3.1] Phase 3: wire the converter in

Aperta
#951 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 5 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
java, openapi
Ambito
api, tooling

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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
Lingua principale
Java
Stelle
1.1k
Fork
191
Merge medio
4g 23h
PR unite (30g)
1

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di OpenAPITools/openapi-diff

Tutte le issue di OpenAPITools/openapi-diff

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.