-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
Add 2022-09-30-preview for service operations in MySQL #23900
Conversation
Hi, @xiaoxuqi-ms 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.10.4)] | new version | base version |
---|---|---|
ServiceOperations.json | 2022-09-30-preview(d60f356) | 2022-01-01(main) |
ServiceOperations.json | 2022-09-30-preview(d60f356) | 2021-12-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Rule | Message |
---|---|
1036 - ConstraintChanged |
The new version has a different 'pattern' value than the previous one. New: ServiceOperations/preview/2022-09-30-preview/ServiceOperations.json#L49:9 Old: ServiceOperations/stable/2022-01-01/ServiceOperations.json#L49:9 |
1036 - ConstraintChanged |
The new version has a different 'pattern' value than the previous one. New: ServiceOperations/preview/2022-09-30-preview/ServiceOperations.json#L91:9 Old: ServiceOperations/stable/2022-01-01/ServiceOperations.json#L91:9 |
1036 - ConstraintChanged |
The new version has a different 'pattern' value than the previous one. New: ServiceOperations/preview/2022-09-30-preview/ServiceOperations.json#L139:9 Old: ServiceOperations/stable/2022-01-01/ServiceOperations.json#L139:9 |
1036 - ConstraintChanged |
The new version has a different 'pattern' value than the previous one. New: Microsoft.DBforMySQL/common-types/v1/common-types.json#L25:5 Old: ServiceOperations/stable/2022-01-01/ServiceOperations.json#L637:5 |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.1) | new version | base version |
---|---|---|
package-flexibleserver-2022-09-30-preview-privatelink | package-flexibleserver-2022-09-30-preview-privatelink(d60f356) | package-flexibleserver-2022-09-30-preview-privatelink(main) |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.DBforMySQL/operations' does not match the ARM specification. Please standardize the schema. Location: ServiceOperations/preview/2022-09-30-preview/ServiceOperations.json#L273 |
OperationsApiSchemaUsesCommonTypes |
Operations API path must follow the schema provided in the common types. Location: ServiceOperations/preview/2022-09-30-preview/ServiceOperations.json#L274 |
OperationId should contain the verb: 'checkvirtualnetworksubnetusage' in:'CheckVirtualNetworkSubnetUsage_Execute'. Consider updating the operationId Location: ServiceOperations/preview/2022-09-30-preview/ServiceOperations.json#L84 |
|
OperationId should contain the verb: 'checknameavailability' in:'CheckNameAvailability_Execute'. Consider updating the operationId Location: ServiceOperations/preview/2022-09-30-preview/ServiceOperations.json#L132 |
|
OperationId should contain the verb: 'checknameavailability' in:'CheckNameAvailabilityWithoutLocation_Execute'. Consider updating the operationId Location: ServiceOperations/preview/2022-09-30-preview/ServiceOperations.json#L180 |
|
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Check name availability Location: ServiceOperations/preview/2022-09-30-preview/ServiceOperations.json#L181 |
|
OperationId should contain the verb: 'getprivatednszonesuffix' in:'GetPrivateDnsZoneSuffix_Execute'. Consider updating the operationId Location: ServiceOperations/preview/2022-09-30-preview/ServiceOperations.json#L225 |
|
Property location must have 'x-ms-mutability':['read', 'create'] extension defined.Location: ServiceOperations/preview/2022-09-30-preview/ServiceOperations.json#L321 |
|
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: ServiceOperations/preview/2022-09-30-preview/ServiceOperations.json#L546 |
️⚠️
Avocado: 1 Warnings warning [Detail]
Rule | Message |
---|---|
The default tag contains multiple API versions swaggers. readme: specification/mysql/resource-manager/readme.md tag: specification/mysql/resource-manager/readme.md#tag-package-2020-01-01 |
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️❌
~[Staging] ServiceAPIReadinessTest: 34 Errors, 0 Warnings failed [Detail]
Tag package-flexibleserver-2022-09-30-preview-privatelink; Prod region: Deployed
Test run on region: westcentralus; Operation coverage: total: 44, untested: 0, failed: 32, passed: 12
Service API Readiness Test failed. Check pipeline artifact for detail report.
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
CLIENT_ERROR |
statusCode: 403, errorCode: AuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' does not have authorization to perform action 'Microsoft.DBforMySQL/locations/checkNameAvailability/action' over scope '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5' or the scope is invalid. If access was recently granted, please refresh your credentials. Source: runtime OperationId: CheckNameAvailability_Execute |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The requested resource of type 'Microsoft.DBforMySQL/flexibleServers' with name 'servernah9rrns' was not found. Source: runtime OperationId: Servers_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The requested resource of type 'Microsoft.DBforMySQL/flexibleServers' with name 'servernah9rrns' was not found. Source: runtime OperationId: Servers_Update |
CLIENT_ERROR |
statusCode: 404, errorCode: ServerNotFound, errorMessage: Subscription 'db5eb68e-73e2-4fa8-b18a-46cd1be4cce5' does not have the server 'servernah9rrns'. Source: runtime OperationId: Servers_Restart |
CLIENT_ERROR |
statusCode: 404, errorCode: ServerNotFound, errorMessage: Subscription 'db5eb68e-73e2-4fa8-b18a-46cd1be4cce5' does not have the server 'servernah9rrns'. Source: runtime OperationId: Servers_Failover |
SERVER_ERROR |
statusCode: 500, errorCode: InternalServerError, errorMessage: An unexpected error occured while processing the request. Tracking ID: '2459cd4f-b7cd-4342-934e-dc5a2e0ea1fc' Source: runtime OperationId: PrivateEndpointConnections_CreateOrUpdate |
SERVER_ERROR |
statusCode: 500, errorCode: InternalServerError, errorMessage: An unexpected error occured while processing the request. Tracking ID: '414e2637-21f9-4079-8683-d4ddf1035e2d' Source: runtime OperationId: PrivateEndpointConnections_ListByServer |
SERVER_ERROR |
statusCode: 500, errorCode: InternalServerError, errorMessage: An unexpected error occured while processing the request. Tracking ID: 'bcbfeb17-6d50-4b0c-8436-d4300307041c' Source: runtime OperationId: PrivateEndpointConnections_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ServerNotExist, errorMessage: The server 'servernah9rrns' does not exist or in unexpected status. Source: runtime OperationId: Configurations_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: ServerNotExist, errorMessage: The server 'servernah9rrns' does not exist or in unexpected status. Source: runtime OperationId: Configurations_ListByServer |
CLIENT_ERROR |
statusCode: 404, errorCode: ServerNotExist, errorMessage: The server 'servernah9rrns' does not exist or in unexpected status. Source: runtime OperationId: Configurations_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ServerNotExist, errorMessage: The server 'servernah9rrns' does not exist or in unexpected status. Source: runtime OperationId: Configurations_Update |
CLIENT_ERROR |
statusCode: 404, errorCode: ServerNotExist, errorMessage: The server 'servernah9rrns' does not exist or in unexpected status. Source: runtime OperationId: Configurations_BatchUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: ServerNotExist, errorMessage: The server 'servernah9rrns' does not exist or in unexpected status. Source: runtime OperationId: Databases_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: ServerNotExist, errorMessage: The server 'servernah9rrns' does not exist or in unexpected status. Source: runtime OperationId: Databases_ListByServer |
CLIENT_ERROR |
statusCode: 404, errorCode: ServerNotExist, errorMessage: The server 'servernah9rrns' does not exist or in unexpected status. Source: runtime OperationId: Databases_Get |
SERVER_ERROR |
statusCode: 500, errorCode: InternalServerError, errorMessage: An unexpected error occured while processing the request. Tracking ID: 'd0901607-3032-4bf6-89db-e49477794a56' Source: runtime OperationId: FirewallRules_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: ServerNotExist, errorMessage: The server 'servernah9rrns' does not exist or in unexpected status. Source: runtime OperationId: FirewallRules_ListByServer |
CLIENT_ERROR |
statusCode: 404, errorCode: ServerNotExist, errorMessage: The server 'servernah9rrns' does not exist or in unexpected status. Source: runtime OperationId: FirewallRules_Get |
CLIENT_ERROR |
statusCode: 400, errorCode: InvalidParameterValue, errorMessage: Invalid value given for parameter administratorName. Specify a valid parameter value. Source: runtime OperationId: AzureADAdministrators_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: ServerNotExist, errorMessage: The server 'servernah9rrns' does not exist or in unexpected status. Source: runtime OperationId: AzureADAdministrators_ListByServer |
CLIENT_ERROR |
statusCode: 400, errorCode: InvalidParameterValue, errorMessage: Invalid value given for parameter administratorName. Specify a valid parameter value. Source: runtime OperationId: AzureADAdministrators_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ServerNotExist, errorMessage: The server 'servernah9rrns' does not exist or in unexpected status. Source: runtime OperationId: Backups_Put |
CLIENT_ERROR |
statusCode: 404, errorCode: ServerNotExist, errorMessage: The server 'servernah9rrns' does not exist or in unexpected status. Source: runtime OperationId: Backups_ListByServer |
CLIENT_ERROR |
statusCode: 404, errorCode: ServerNotExist, errorMessage: The server 'servernah9rrns' does not exist or in unexpected status. Source: runtime OperationId: Backups_Get |
CLIENT_ERROR |
statusCode: 400, errorCode: NoRegisteredProviderFound, errorMessage: No registered resource provider found for location 'locationas2iuq' and API version '2022-09-30-preview' for type 'locations/capabilities'. The supported api-versions are '2020-07-01-privatepreview, 2020-07-01-preview, 2021-05-01-preview, 2021-05-01, 2021-12-01-preview, 2022-06-01-privatepreview, 2022-06-01-preview, 2022-09-30-privatepreview, 2022-09-30-preview'. The supported locations are 'australiacentral, australiasoutheast, canadaeast, eastasia, eastus2, germanynorth, germanywestcentral, centralindia, southindia, japanwest, koreasouth, northcentralus, norwayeast, norwaywest, swedencentral, uaenorth, ukwest, westcentralus, westus, westus2, westus3, brazilsouth, brazilsoutheast, francecentral, francesouth, southafricanorth, southafricawest, southeastasia, northeurope, australiaeast, japaneast, koreacentral, uksouth, westeurope, canadacentral, centralus, eastus, switzerlandnorth, switzerlandwest, southcentralus, qatarcentral, eastus2euap, centraluseuap'. Source: runtime OperationId: LocationBasedCapabilities_List |
CLIENT_ERROR |
statusCode: 403, errorCode: AuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' does not have authorization to perform action 'Microsoft.DBforMySQL/locations/checkVirtualNetworkSubnetUsage/action' over scope '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5' or the scope is invalid. If access was recently granted, please refresh your credentials. Source: runtime OperationId: CheckVirtualNetworkSubnetUsage_Execute |
CLIENT_ERROR |
statusCode: 404, errorCode: ServerNotExist, errorMessage: The server 'servernah9rrns' does not exist or in unexpected status. Source: runtime OperationId: LogFiles_ListByServer |
CLIENT_ERROR |
statusCode: 404, errorCode: undefined, errorMessage: undefined Source: runtime OperationId: PrivateLinkResources_Get |
INVALID_CONTENT_TYPE |
Invalid Content-Type (application/octet-stream). These are supported: application/json Source: response OperationId: PrivateLinkResources_Get |
️❌
SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️
CadlAPIView succeeded [Detail] [Expand]
️️✔️
TypeSpecAPIView 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.
️️✔️
TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
Hi @xiaoxuqi-ms, 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. |
Hi Reviewers, |
@xiaoxuqi-ms Please fill in the correct checkboxes in the first comment so we can get a quick overview of what's going on with this PR and make sure you've understood the relevant linked docs. |
That's fine to have no changes. Please fill in the PR description, changelog, etc, anyway. Edit: looks like you just have to do the BreakingChange review for the regex pattern change. ARM Review isn't really required for that, so I'll remove the ARMReview label! |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
@raych1 could you help to take a look at the SDK breaking change in this PR? Thanks |
@tadelesh , can you help me understand the breaking change detected? |
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 LiveValidation site shows a number of missing operations in this API version. Could you please address these issues in this PR as well?
The breaking change is not from this PR's change. You may ignore it. |
Hi @mikekistler, by looking up ARM logs for these missing operations, we find some incoming calls are from portal. We will fix portal template to solve this. And a majority calls are from PolicyScan, we are working with Azure policy team to resolve this issues without unnecessary update of swagger. |
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.
Looks good. 👍
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.