Adding API version 2023-01-15-preview for Failover Group resource type #22493
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi, @charmainewkchan 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. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| activeDirectoryConnectors.json | 2023-01-15-preview(830c2d6) | 2022-06-15-preview(main) |
| azurearcdata.json | 2023-01-15-preview(830c2d6) | 2021-11-01(main) |
| azurearcdata.json | 2023-01-15-preview(830c2d6) | 2022-06-15-preview(main) |
| common.json | 2023-01-15-preview(830c2d6) | 2021-11-01(main) |
| common.json | 2023-01-15-preview(830c2d6) | 2022-06-15-preview(main) |
| dataControllers.json | 2023-01-15-preview(830c2d6) | 2021-11-01(main) |
| dataControllers.json | 2023-01-15-preview(830c2d6) | 2022-06-15-preview(main) |
| operations.json | 2023-01-15-preview(830c2d6) | 2021-11-01(main) |
| operations.json | 2023-01-15-preview(830c2d6) | 2022-06-15-preview(main) |
| postgresInstances.json | 2023-01-15-preview(830c2d6) | 2022-06-15-preview(main) |
| sqlManagedInstances.json | 2023-01-15-preview(830c2d6) | 2021-11-01(main) |
| sqlManagedInstances.json | 2023-01-15-preview(830c2d6) | 2022-06-15-preview(main) |
| sqlServerDatabases.json | 2023-01-15-preview(830c2d6) | 2022-06-15-preview(main) |
| sqlServerInstances.json | 2023-01-15-preview(830c2d6) | 2021-11-01(main) |
| sqlServerInstances.json | 2023-01-15-preview(830c2d6) | 2022-06-15-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| The new version has a different type '' than the previous one 'object'. New: Microsoft.AzureArcData/preview/2023-01-15-preview/sqlManagedInstances.json#L175:7 Old: Microsoft.AzureArcData/preview/2022-06-15-preview/sqlManagedInstances.json#L175:7 |
|
| The new version has a different type '' than the previous one 'object'. New: Microsoft.AzureArcData/preview/2023-01-15-preview/sqlManagedInstances.json#L175:7 Old: Microsoft.AzureArcData/preview/2022-06-15-preview/sqlManagedInstances.json#L175:7 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 3 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2023-01 | package-preview-2023-01(830c2d6) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'SqlManagedInstances_Create' Request Model: 'parameters[3].schema' Response Model: 'responses[200].schema' Location: Microsoft.AzureArcData/preview/2023-01-15-preview/azurearcdata.json#L178 |
||
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'FailoverGroups_Create' Request Model: 'parameters[2].schema' Response Model: 'responses[200].schema' Location: Microsoft.AzureArcData/preview/2023-01-15-preview/azurearcdata.json#L377 |
||
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AzureArcData/preview/2023-01-15-preview/failoverGroups.json#L41 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
Per the Noun_Verb convention for Operation Ids, the noun 'DataControllers' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureArcData/preview/2023-01-15-preview/azurearcdata.json#L892 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'DataControllers' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureArcData/preview/2023-01-15-preview/azurearcdata.json#L951 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'DataControllers' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureArcData/preview/2023-01-15-preview/azurearcdata.json#L995 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'DataControllers' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureArcData/preview/2023-01-15-preview/azurearcdata.json#L1035 |
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AzureArcData/preview/2023-01-15-preview/activeDirectoryConnectors.json#L41 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.AzureArcData/preview/2023-01-15-preview/activeDirectoryConnectors.json#L157 |
|
| 'PUT' operation 'DataControllers_PutDataController' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureArcData/preview/2023-01-15-preview/azurearcdata.json#L892 |
|
| 'PATCH' operation 'DataControllers_PatchDataController' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureArcData/preview/2023-01-15-preview/azurearcdata.json#L1035 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.AzureArcData/preview/2023-01-15-preview/common.json#L18 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AzureArcData/preview/2023-01-15-preview/dataControllers.json#L26 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AzureArcData/preview/2023-01-15-preview/dataControllers.json#L63 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.AzureArcData/preview/2023-01-15-preview/operations.json#L35 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AzureArcData/preview/2023-01-15-preview/operations.json#L46 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AzureArcData/preview/2023-01-15-preview/postgresInstances.json#L80 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AzureArcData/preview/2023-01-15-preview/postgresInstances.json#L105 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AzureArcData/preview/2023-01-15-preview/sqlManagedInstances.json#L22 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.AzureArcData/preview/2023-01-15-preview/sqlManagedInstances.json#L65 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AzureArcData/preview/2023-01-15-preview/sqlServerDatabases.json#L289 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.AzureArcData/preview/2023-01-15-preview/sqlServerDatabases.json#L349 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.AzureArcData/preview/2023-01-15-preview/sqlServerDatabases.json#L370 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.AzureArcData/preview/2023-01-15-preview/sqlServerDatabases.json#L373 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.AzureArcData/preview/2023-01-15-preview/sqlServerDatabases.json#L376 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.AzureArcData/preview/2023-01-15-preview/sqlServerDatabases.json#L379 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.AzureArcData/preview/2023-01-15-preview/sqlServerDatabases.json#L382 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.AzureArcData/preview/2023-01-15-preview/sqlServerDatabases.json#L385 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.AzureArcData/preview/2023-01-15-preview/sqlServerDatabases.json#L388 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.AzureArcData/preview/2023-01-15-preview/sqlServerDatabases.json#L391 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AzureArcData/preview/2023-01-15-preview/sqlServerDatabases.json#L432 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AzureArcData/preview/2023-01-15-preview/sqlServerInstances.json#L22 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 19 Errors, 0 Warnings failed [Detail]
Tag package-preview-2023-01; Prod region: Not deployed; Canary region: Deployed
Test run on region: eastus2euap; Operation coverage: total: 38, untested: 0, failed: 19, passed: 19
Service API Readiness Test failed. Check pipeline artifact for detail report.
| Rule | Message |
|---|---|
|
statusCode: 502, errorCode: ProviderError, errorMessage: Resource provider 'Microsoft.AzureArcData' failed to return collection response for type 'SqlServerInstances'. Source: runtime OperationId: SqlServerInstances_List |
|
statusCode: 502, errorCode: ProviderError, errorMessage: Resource provider 'Microsoft.AzureArcData' failed to return collection response for type 'SqlServerInstances'. Source: runtime OperationId: SqlServerInstances_ListByResourceGroup |
|
statusCode: 400, errorCode: InvalidCustomLocation, errorMessage: The specified extended location name '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5/resourceGroups/apiTest-AbJUFo-22493/providers/Microsoft.ExtendedLocation/customLocations/arclocation' is invalid. The custom location was not found. Source: runtime OperationId: DataControllers_PutDataController |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.AzureArcData/DataControllers/datacontutx3ln' under resource group 'apiTest-AbJUFo-22493' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: DataControllers_GetDataController |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.AzureArcData/DataControllers/datacontutx3ln' under resource group 'apiTest-AbJUFo-22493' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: DataControllers_PatchDataController |
|
statusCode: 400, errorCode: InvalidRequestContent, errorMessage: The request content was invalid and could not be deserialized: 'Could not find member 'dev' on object of type 'ResourceSku'. Path 'sku.dev', line 13, position 10.'. Source: runtime OperationId: SqlManagedInstances_Create |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.AzureArcData/SqlManagedInstances/sqlmanagh4u6um' under resource group 'apiTest-AbJUFo-22493' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: SqlManagedInstances_Get |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.AzureArcData/SqlManagedInstances/sqlmanagh4u6um' under resource group 'apiTest-AbJUFo-22493' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: SqlManagedInstances_Update |
|
statusCode: 400, errorCode: InvalidRequestContent, errorMessage: The request content was invalid and could not be deserialized: 'Could not find member 'dev' on object of type 'ResourceSku'. Path 'sku.dev', line 90, position 10.'. Source: runtime OperationId: PostgresInstances_Create |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.AzureArcData/PostgresInstances/postgresmhdk37' under resource group 'apiTest-AbJUFo-22493' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: PostgresInstances_Get |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.AzureArcData/PostgresInstances/postgresmhdk37' under resource group 'apiTest-AbJUFo-22493' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: PostgresInstances_Update |
|
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'datacontutx3ln' not found. Source: runtime OperationId: ActiveDirectoryConnectors_Create |
|
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'datacontutx3ln' not found. Source: runtime OperationId: ActiveDirectoryConnectors_List |
|
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'datacontutx3ln' not found. Source: runtime OperationId: ActiveDirectoryConnectors_Get |
|
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'sqlmanagh4u6um' not found. Source: runtime OperationId: FailoverGroups_Create |
|
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'sqlmanagh4u6um' not found. Source: runtime OperationId: FailoverGroups_List |
|
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'sqlmanagh4u6um' not found. Source: runtime OperationId: FailoverGroups_Get |
|
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'sqlmanagh4u6um' not found. Source: runtime OperationId: FailoverGroups_Delete |
|
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'datacontutx3ln' not found. Source: runtime OperationId: ActiveDirectoryConnectors_Delete |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView 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.
️️✔️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
|
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @charmainewkchan, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
This was referenced Feb 7, 2023
|
Hi, @charmainewkchan, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
|
Regarding these breaking changes: 1011: This response code is present in the previous api-version 2022-06-15-preview here, so I don’t believe it is a breaking change. 1026: This change is to address these model validations errors. @Monica Adusumilli was advised to fix this in order to avoid requesting exceptions for this every time. 1044: The previous 2022-06-15-preview version already had this change. 1048: The previous 2022-06-15-preview version had this x-ms-enum extension. PR of these changes in azure-rest-api-specs-pr RPSaaSMaster branch: https://github.com/Azure/azure-rest-api-specs-pr/pull/10350 Regarding "CI-MissingBaseCommit": |
mikekistler
added
the
Approved-BreakingChange
|
Breaking change previously reviewed and approved in https://github.com/Azure/azure-rest-api-specs-pr/pull/10350 |
live1206
approved these changes
Feb 10, 2023
|
/azp run |
rkmanda
reviewed
Feb 15, 2023
...-manager/Microsoft.AzureArcData/preview/2023-01-15-preview/examples/DeleteFailoverGroup.json
Outdated
Show resolved
Hide resolved
rkmanda
reviewed
Feb 15, 2023
...-manager/Microsoft.AzureArcData/preview/2023-01-15-preview/examples/DeleteFailoverGroup.json
Show resolved
Hide resolved
rkmanda
added
the
ARMChangesRequested
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
added 2 commits
February 22, 2023 16:09
live1206
removed
the
ARMChangesRequested
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi @charmainewkchan, Your PR has some issues. Please fix the CI sequentially by following the order of
|
charmainewkchan
requested review from
zizw123
and removed request for
live1206
NetRock
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
added 2 commits
February 24, 2023 12:07
…is not needed for customer's PUT request
This was referenced Mar 2, 2023
Closed
Closed
aviyerMSFT
pushed a commit
to aviyerMSFT/azure-rest-api-specs
that referenced
this pull request
Mar 22, 2023
Azure#22493) * Adding base version * Updates API version in new specs and examples * Adds failover group resource type and examples * Add API version to readme * Resolve PR comments, added enums for provisoning state, and ms-identifiers for array * Address comments, expand property name, add descriptions, add enums when possible * Improve descriptions * Add azure-AsyncOperation header and mark public certificate as not a secret * Fix avocado parsing error * Revert property name to align with cluster properties, this property is not needed for customer's PUT request * Make additional property type any, and add to properties for metatdata --------- Co-authored-by: Charmaine Chan <chachan@microsoft.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
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.