api-version should not cause a ChangedParameterOrder error
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
Research direction
Search the repository for the ChangedParameterOrder rule and its handling of parameter references, then compare the original and updated parameter lists shown in the issue. Done means ApiVersionParameter reordering no longer produces this breaking-change error while other parameter-order changes remain detected; validate with the issue's example and the relevant project checks.
Written by the indexing model from the issue text.
Description
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.
"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:
"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.
- Dominant language
- C#
- Stars
- 290
- Forks
- 50
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 10
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Azure/openapi-diff
-
Azure/openapi-diff#482 · 1 assignee ·
-
Azure/openapi-diff#479 · 2 comments · 1 assignee ·
-
Azure/openapi-diff#456 · 1 assignee ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
Azure/openapi-diff#445 ·
-
Azure/openapi-diff#371 · 7 comments · 1 assignee ·
All issues in Azure/openapi-diff
Similar issues
-
Documentation
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
cake-build/cake#5024 ·
-
Frontend status/draft TechnicalDebt
Difficulty 2/5 1-2 days Newbie friendliness 75/100
Altinn/altinn-auth#4143 ·
-
.NET Flaky Test Testing Tests
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
getsentry/sentry-dotnet#5617 · 1 comment ·
-
:watch: Not Triaged dotnet-fsharp/svc
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
Client customer-reported needs-team-attention question Service Attention WebPubSub
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Azure/azure-sdk-for-net#63292 · 3 comments · 1 reaction ·