Azure / Azure/openapi-diff

Removing `readOnly: true` on response-only property is flagged as error

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

Description

While migrating Key Vault specs from Swagger to TSP, we [removed](https://github.com/Azure/azure-rest-api-specs/pull/28708/commits/bde57be10ffbd04acc86fe2d441e4aae8a62bbbc) a `readOnly` designation for a property on a response-only type. This was [flagged as an error](https://dev.azure.com/azure-sdk/internal/_build/results?buildId=4481832&view=logs&j=98f87804-8e1f-5655-af02-e80aefa7aa97&t=65457206-7ab6-5966-2a2f-9ae3efa14a03&l=931-955) by the OpenAPI diff; per context in [this review thread](https://github.com/Azure/azure-rest-api-specs/pull/28708#discussion_r1917533739), this error doesn't seem to be correct.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Start by reviewing the linked Key Vault migration commit, OpenAPI diff build log, and the referenced pull-request review thread to understand how response-only properties are compared. Reproduce the reported false error and determine the expected result for removing readOnly: true; done means the diff no longer flags this valid change while still detecting genuine breaking changes.

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

Évaluation

Stack technique
csharp, openapi
Domaine
cli, devtools
Type d'issue
Bug
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

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