Azure / Azure/openapi-diff

No difference reported for required property changed to optional

Ouverte
#207 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub
bug
Langage dominant
C#
Étoiles
290
Forks
50
Merge moyen
5 j 13 h
PR mergées (30 j)
5

Description

Openapi-diff does not report a required property that was changed to optional -- removed from the schema "required" array. Changing a required property to optional in an output schema could cause breaking changes if a client relies on a property always being present in a response (because it was marked "required") and the property is then omitted from some responses in the new version.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Start at the command-line tool's OpenAPI schema comparison and trace how the schema "required" array is handled. Reproduce the reported transition from required to optional in two specifications, then verify that the tool reports the change as breaking.

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

Évaluation

Stack technique
csharp
Domaine
api, cli
Type d'issue
Bug
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
42/100

Recevez les nouvelles issues par e-mail

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