[Hub Generated] Publish private branch 'appplatform/release/s218' #23213
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
|
The PR is created based on the updates in the private branch. The updates in the PR has already been reviewed and approved with this PR Azure/azure-rest-api-specs-pr/11665 |
zmssp
requested review from
msyyc,
Wzb123456789 and
ArcturusZhang
as code owners
|
Hi, @zmssp 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 |
|---|---|---|
| appplatform.json | 2023-03-01-preview(db181ec) | 2022-12-01(main) |
| appplatform.json | 2023-03-01-preview(db181ec) | 2023-01-01-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:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 5 Errors, 7 Warnings failed [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2023-03 | package-preview-2023-03(db181ec) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/containerRegistries' Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L1559 |
|
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/containerRegistries/{containerRegistryName}' Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L1604 |
|
|
An async PUT operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'azure-async-operation' on 'x-ms-long-running-operation-options' Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L1648 |
RPC-Async-V1-01 |
|
An async PUT operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'azure-async-operation' on 'x-ms-long-running-operation-options' Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L1800 |
RPC-Async-V1-01 |
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/restart' Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L6085 |
|
| 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: 'ContainerRegistries_CreateOrUpdate' Request Model: 'parameters[5].schema' Response Model: 'responses[200].schema' Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L1648 |
||
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: BuildService_ListBuildServices Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L1749 |
||
| 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: 'BuildService_CreateOrUpdate' Request Model: 'parameters[5].schema' Response Model: 'responses[200].schema' Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L1800 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'BuildServiceModel'. Consider using the plural form of 'BuildService' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L1805 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'BuildServiceModel'. Consider using the plural form of 'BuildService' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L2024 |
||
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L8080 |
||
| 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.AppPlatform/preview/2023-03-01-preview/appplatform.json#L9762 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}' Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L19 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L63 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L105 |
|
A 202 response should include an Location response header. Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L105 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L134 |
|
A 202 response should include an Location response header. Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L158 |
|
The patch operation body parameter schema should not contains property name. Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L197 |
|
The patch operation body parameter schema should not contains property type. Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L197 |
|
The patch operation body parameter schema should not contains property location. Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L197 |
|
A 202 response should include an Location response header. Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L214 |
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/listTestKeys' Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L235 |
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/regenerateTestKey' Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L277 |
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/disableTestEndpoint' Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L328 |
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/enableTestEndpoint' Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L367 |
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/stop' Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L409 |
|
A 'post' operation 'Services_Stop' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201 or 202 or 204. Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L410 |
|
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L410 |
|
A 202 response should include an Location response header. Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L431 |
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/start' Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L457 |
|
A 'post' operation 'Services_Start' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201 or 202 or 204. Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L458 |
|
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L458 |
|
A 202 response should include an Location response header. Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L479 |
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configServers/default' Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L505 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L546 |
|
An async PUT operation must return 201. Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L575 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L582 |
|
A 202 response should include an Location response header. Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L582 |
|
The patch operation body parameter schema should not contains property name. Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L621 |
|
The patch operation body parameter schema should not contains property type. Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L621 |
|
A 202 response should include an Location response header. Location: Microsoft.AppPlatform/preview/2023-03-01-preview/appplatform.json#L638 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️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]
️️✔️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
ARMReview
BreakingChangeReviewRequired
|
Hi @zmssp, 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 @zmssp, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Mar 22, 2023
yuwzho
approved these changes
Mar 22, 2023
raych1
added
Approved-BreakingChange
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
raych1
removed
WaitForARMFeedback
raych1
approved these changes
Mar 23, 2023
raych1
deleted the
published/Azure/azure-rest-api-specs-pr/appplatform/release/s218
branch
This was referenced Mar 23, 2023
JoshLove-msft
pushed a commit
to JoshLove-msft/azure-rest-api-specs
that referenced
this pull request
Apr 25, 2023
… api (Azure#23213) Co-authored-by: swagger-automation <swagger@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.
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
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.