[OpenAPI 3.1] Phase 3: wire the converter in

Ouverte
#951 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 5 jours

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
35/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
Active
Stack technique
java, openapi
Domaine
api, tooling

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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
Langage dominant
Java
Étoiles
1.1k
Forks
191
Merge moyen
4 j 23 h
PR mergées (30 j)
1

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de OpenAPITools/openapi-diff

Toutes les issues de OpenAPITools/openapi-diff

Issues similaires

Plus d'issues Java

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.