api-version should not cause a ChangedParameterOrder error
- Ngôn ngữ chính
- C#
- Star
- 290
- Fork
- 50
- Merge trung bình
- 5 ngày 13 giờ
- Pull request đã merge (30 ngày)
- 5
Mô tả
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.
Hướng dẫn đóng góp
Hướng nghiên cứu
Tìm trong repository quy tắc ChangedParameterOrder và cách quy tắc này xử lý các tham chiếu tham số, sau đó so sánh danh sách tham số ban đầu và danh sách đã cập nhật được nêu trong issue. Được coi là hoàn tất khi việc sắp xếp lại ApiVersionParameter không còn tạo ra lỗi breaking change này, trong khi các thay đổi thứ tự tham số khác vẫn được phát hiện; hãy xác thực bằng ví dụ trong issue và các kiểm tra liên quan của project.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- csharp
- Lĩnh vực
- api, cli
- Loại issue
- Lỗi
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 45/100