-
Notifications
You must be signed in to change notification settings - Fork 5.5k
Remove x-ms-external property for Redis 2022-05-01 and 2021-06-01 API versions #20837
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
Hi, @austintolani Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
Swagger Validation Report
|
| compared swaggers (via Oad v0.9.7)] | new version | base version |
|---|---|---|
| redis.json | 2021-06-01(6346d5c) | 2021-06-01(main) |
| redis.json | 2022-05-01(6346d5c) | 2022-05-01(main) |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2022-05 | package-2022-05(6346d5c) | package-2022-05(main) |
| package-2021-06 | package-2021-06(6346d5c) | package-2021-06(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/providers/Microsoft.Cache/CheckNameAvailability' Location: Microsoft.Cache/stable/2021-06-01/redis.json#L73 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/providers/Microsoft.Cache/CheckNameAvailability' Location: Microsoft.Cache/stable/2022-05-01/redis.json#L73 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.Cache/stable/2021-06-01/redis.json#L2423 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.Cache/stable/2022-05-01/redis.json#L2425 |
R4018 - OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.Cache/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.Cache/stable/2021-06-01/redis.json#L37 |
R4018 - OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.Cache/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.Cache/stable/2022-05-01/redis.json#L37 |
R4037 - MissingTypeObject |
The schema 'Sku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2021-06-01/redis.json#L1842 |
R4037 - MissingTypeObject |
The schema 'RedisCommonProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2021-06-01/redis.json#L1882 |
R4037 - MissingTypeObject |
The schema 'RedisCreateProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2021-06-01/redis.json#L2020 |
R4037 - MissingTypeObject |
The schema 'RedisUpdateProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2021-06-01/redis.json#L2063 |
R4037 - MissingTypeObject |
The schema 'RedisProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2021-06-01/redis.json#L2078 |
R4037 - MissingTypeObject |
The schema 'RedisCreateParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2021-06-01/redis.json#L2161 |
R4037 - MissingTypeObject |
The schema 'RedisUpdateParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2021-06-01/redis.json#L2201 |
R4037 - MissingTypeObject |
The schema 'RedisAccessKeys' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2021-06-01/redis.json#L2222 |
R4037 - MissingTypeObject |
The schema 'RedisFirewallRule' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2021-06-01/redis.json#L2237 |
R4037 - MissingTypeObject |
The schema 'RedisFirewallRuleProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2021-06-01/redis.json#L2263 |
R4037 - MissingTypeObject |
The schema 'RedisFirewallRuleListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2021-06-01/redis.json#L2280 |
R4037 - MissingTypeObject |
The schema 'RedisResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2021-06-01/redis.json#L2297 |
R4037 - MissingTypeObject |
The schema 'RedisInstanceDetails' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2021-06-01/redis.json#L2326 |
R4037 - MissingTypeObject |
The schema 'RedisListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2021-06-01/redis.json#L2364 |
R4037 - MissingTypeObject |
The schema 'RedisRegenerateKeyParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2021-06-01/redis.json#L2381 |
R4037 - MissingTypeObject |
The schema 'RedisRebootParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2021-06-01/redis.json#L2401 |
R4037 - MissingTypeObject |
The schema 'ExportRDBParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2021-06-01/redis.json#L2431 |
R4037 - MissingTypeObject |
The schema 'ImportRDBParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2021-06-01/redis.json#L2452 |
R4037 - MissingTypeObject |
The schema 'ScheduleEntry' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2021-06-01/redis.json#L2471 |
R4037 - MissingTypeObject |
The schema 'ScheduleEntries' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2021-06-01/redis.json#L2509 |
R4037 - MissingTypeObject |
The schema 'RedisPatchSchedule' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2021-06-01/redis.json#L2526 |
R4037 - MissingTypeObject |
The schema 'RedisPatchScheduleListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2021-06-01/redis.json#L2549 |
R4037 - MissingTypeObject |
The schema 'RedisForceRebootResponse' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2021-06-01/redis.json#L2566 |
R4037 - MissingTypeObject |
The schema 'RedisLinkedServer' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2021-06-01/redis.json#L2576 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
Validation passes for ServiceAPIReadinessTest.
️️✔️~[Staging] TrafficValidation succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SDK Track2 Validation succeeded [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/6346d5cba6cc3d44fcca572cbbe63850ee2257ad/specification/redis/resource-manager/readme.md#tag-package-2022-05">redis/resource-manager/readme.md#package-2022-05
- "https://github.com/Azure/azure-rest-api-specs/blob/6346d5cba6cc3d44fcca572cbbe63850ee2257ad/specification/redis/resource-manager/readme.md#tag-package-2021-06">redis/resource-manager/readme.md#package-2021-06
| Rule | Message |
|---|---|
PreCheck/DuplicateSchema |
"readme":"redis/resource-manager/readme.md", "tag":"package-2022-05", "details":"Duplicate Schema named 'ErrorDetail' (1 differences):\n - properties.details.$ref: "#/components/schemas/schemas:249" => "#/components/schemas/schemas:461"; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"redis/resource-manager/readme.md", "tag":"package-2022-05", "details":"Error: 1 errors occured -- cannot continue." |
PreCheck/DuplicateSchema |
"readme":"redis/resource-manager/readme.md", "tag":"package-2021-06", "details":"Duplicate Schema named 'ErrorDetail' (1 differences):\n - properties.details.$ref: "#/components/schemas/schemas:247" => "#/components/schemas/schemas:459"; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"redis/resource-manager/readme.md", "tag":"package-2021-06", "details":"Error: 1 errors occured -- cannot continue." |
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
| "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationStatusResult" | ||
| } | ||
| ], | ||
| "x-ms-external": true |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there any reason to remove this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@akning-ms its inclusion is creating problems when generating our .NET SDK. It seems like it should have never been set in the first place.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The Go breaking is from code generator and could be ignored.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@qiaozha is the JS breaking change OK also?
|
@akning-ms @tadelesh Thank you for reviewing this PR. Is there anything we need to do on our end to get this PR merged? Our .NET SDK release is dependent on these changes so we would like to get it merged ASAP. |
… versions (Azure#20837) * remove x-ms-external tag for 2022-05-01 API version * remove x-ms-external tag for 2021-06-01 API version
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
What's the purpose of the update?
Fixing issue in existing version (
x-ms-externalshould not be set forOperationStatus).When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
These API versions already been deployed.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
Swagger to be published ASAP.
By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.