[OpenAPI 3.1] Phase 1: 3.0→3.1 converter

Ouverte
#949 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
38/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
Active
Stack technique
java, openapi
Domaine
tooling

Piste de recherche

Start from the plan in #942, then look at how org.openapitools.openapidiff.core currently parses specs and where swagger-core's mapper and JsonSchema are already used. The new normalize package must walk components, parameters, headers, bodies, callbacks and nested schemas, applying the listed rules on a deep copy. Compare converted 3.0 output against natively parsed 3.1 for the paired fixtures under the test resources as serialized JSON; also add the Swagger 2.0 fixture and a test asserting the input objects are unchanged.

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 1)

Goal

A converter that turns Swagger 2.0 / OpenAPI 3.0 objects into the 3.1 form. Not wired in yet.

Scope
  • New package org.openapitools.openapidiff.core.normalize, called once per spec
  • Walks every schema: components, parameters, headers, request/response bodies, callbacks, and nested (properties, items, additionalProperties, allOf/anyOf/oneOf, not)
  • Rules: type → types; nullable: true → "null" in types (not when there is no type); boolean exclusiveMinimum/Maximum → numeric; example → examples; typed classes → JsonSchema
  • Works on a copy (JSON round-trip with swagger-core's mapper), so the input objects are never modified
Done when
  • Converted 3.0 == natively parsed 3.1 (compared as serialized JSON) for all paired fixtures
  • Swagger 2.0 fixture converts correctly
  • Copy test: input objects are unchanged after conversion
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.