-
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 new preview version 2022-09-30-preview for private link #23067
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 |
---|---|---|
PrivateEndpointConnections.json | 2022-09-30-preview(efd5cd2) | 2018-06-01(main) |
PrivateEndpointConnections.json | 2022-09-30-preview(efd5cd2) | 2018-06-01-privatepreview(main) |
PrivateLinkResources.json | 2022-09-30-preview(efd5cd2) | 2018-06-01(main) |
PrivateLinkResources.json | 2022-09-30-preview(efd5cd2) | 2018-06-01-privatepreview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Only 30 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌
LintDiff: 6 Errors, 11 Warnings failed [Detail]
compared tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-flexibleserver-2022-09-30-preview-privatelink | package-flexibleserver-2022-09-30-preview-privatelink(efd5cd2) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
ImplementPrivateEndpointAPIs |
The private endpoint API: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/privateLinkResources is missing. Location: PrivateLink/preview/2022-09-30-preview/PrivateEndpointConnections.json#L36 |
|
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: PrivateLink/preview/2022-09-30-preview/PrivateEndpointConnections.json#L133 |
RPC-Async-V1-01 |
GetCollectionResponseSchema |
The response in the GET collection operation 'PrivateEndpointConnections_ListByServer' does not match the response definition in the individual GET operation 'PrivateEndpointConnections_Get' . Location: PrivateLink/preview/2022-09-30-preview/PrivateEndpointConnections.json#L217 |
|
ImplementPrivateEndpointAPIs |
The private endpoint API: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/privateEndpointConnections/{privateEndpointConnectionName} is missing. Location: PrivateLink/preview/2022-09-30-preview/PrivateLinkResources.json#L36 |
|
ImplementPrivateEndpointAPIs |
The private endpoint API: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/privateEndpointConnections is missing. Location: PrivateLink/preview/2022-09-30-preview/PrivateLinkResources.json#L36 |
|
GetCollectionResponseSchema |
The response in the GET collection operation 'PrivateLinkResources_ListByServer' does not match the response definition in the individual GET operation 'PrivateLinkResources_Get' . Location: PrivateLink/preview/2022-09-30-preview/PrivateLinkResources.json#L37 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: PrivateLink/preview/2022-09-30-preview/PrivateEndpointConnections.json#L44 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: PrivateLink/preview/2022-09-30-preview/PrivateEndpointConnections.json#L92 |
||
Parameter should have a description. Location: PrivateLink/preview/2022-09-30-preview/PrivateEndpointConnections.json#L99 |
||
Parameter should have a description. Location: PrivateLink/preview/2022-09-30-preview/PrivateEndpointConnections.json#L105 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: PrivateLink/preview/2022-09-30-preview/PrivateEndpointConnections.json#L164 |
||
Parameter should have a description. Location: PrivateLink/preview/2022-09-30-preview/PrivateEndpointConnections.json#L171 |
||
Based on the response model schema, operation 'PrivateEndpointConnections_ListByServer' might be pageable. Consider adding the x-ms-pageable extension. Location: PrivateLink/preview/2022-09-30-preview/PrivateEndpointConnections.json#L218 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: PrivateLink/preview/2022-09-30-preview/PrivateEndpointConnections.json#L224 |
||
Based on the response model schema, operation 'PrivateLinkResources_ListByServer' might be pageable. Consider adding the x-ms-pageable extension. Location: PrivateLink/preview/2022-09-30-preview/PrivateLinkResources.json#L38 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: PrivateLink/preview/2022-09-30-preview/PrivateLinkResources.json#L44 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: PrivateLink/preview/2022-09-30-preview/PrivateLinkResources.json#L86 |
️⚠️
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: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
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 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
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 @xiaoxuqi-ms, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi, @xiaoxuqi-ms, 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 |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
approved linter diff as it is green in Linter (staging) and linter error for privatelink is false alarm according to Jianye |
) * add new version 20220901 based on 20211201preview * change api version, examples and readme * fix linter errors * fix api version * add privatelink * fix private link validation * fix private link * fix private link model * fix * use 2022-09-30-preview as version * fix readme * add private link only * revert readme.com * add readme * add priviate link in readme to fix avocado * fix 202 for LRO * fix avocado: remove inner common-tyoe * fix * fix * fix conflict
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.