Azure / Azure/openapi-diff

api-version should not cause a ChangedParameterOrder error

Offen
#287 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
C#
Sterne
290
Forks
50
Ø Merge
5 T. 13 Std.
Gemergte PRs (30 T.)
5

Beschreibung

I'm working on https://github.com/Azure/azure-rest-api-specs-pr/pull/15631 . I have 57 `ChangedParameterOrder` breaking change errors. Many are due to `ApiVersionParameter` changing order. It should be ignored by the `ChangedParameterOrder` rule.

ChangedParameterOrder

This is the original.
``` json
"operationId": "Locations_CheckQuotaAvailability",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "location",
"in": "path",
"required": true,
"type": "string",
"description": "Azure region"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
}
],
```

To:
``` json
"operationId": "Locations_CheckQuotaAvailability",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "location",
"in": "path",
"description": "A location in a subscription",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._]+$"
}
],
```

If I move the ApiVersionParameter in the original version to be first, the rule does not consider it breaking.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Durchsuche das Repository nach der Regel ChangedParameterOrder und ihrer Behandlung von Parameterreferenzen und vergleiche anschließend die in der Issue gezeigten ursprünglichen und aktualisierten Parameterlisten. Als erledigt gilt die Aufgabe, wenn die Neuanordnung von ApiVersionParameter diesen Breaking-Change-Fehler nicht mehr verursacht, während andere Änderungen der Parameterreihenfolge weiterhin erkannt werden; validiere dies mit dem Beispiel aus der Issue und den relevanten Projektprüfungen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp
Bereich
api, cli
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.