OpenAPITools / OpenAPITools/openapi-diff
incompatible api diff result when one of property in model becomes not required
Ouverte
Personne n'a encore pris cette issue.
Breaking/Non-Breaking classification
- Langage dominant
- Java
- Étoiles
- 1.1k
- Forks
- 190
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
if in new api version some property is not required anymore, new api is recognized as not compatible
old api schema definition:
"SomeDto": {
"required": [
"prop1",
"prop2",
"prop3"
], ...
new api schema definition:
"SomeDto": {
"required": [
"prop1"
], ...
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par reproduire la comparaison avec les anciennes et nouvelles définitions de schéma présentées dans l’issue, puis suivez l’endroit où les changements de propriétés obligatoires sont classés comme incompatibles. C’est terminé lorsque le diff gère correctement le passage d’une propriété à l’état facultatif, avec un test de régression couvrant les schémas d’exemple.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- java, openapi
- Domaine
- api, backend-api-design
- Type d'issue
- Bug
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 38/100