update Site schema with container app enviornment #22341
Merged
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, @kaibocai 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 |
|---|---|---|
| CommonDefinitions.json | 2022-09-01(bf3b3f6) | 2022-03-01(main) |
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2022-09 | package-2022-09(bf3b3f6) | package-2022-09(release-web-Microsoft.Web-2022-09-01) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The response in the GET collection operation 'AppServiceCertificateOrders_List' does not match the response definition in the individual GET operation 'AppServiceCertificateOrders_Get' . Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L17 |
|
The response in the GET collection operation 'AppServiceCertificateOrders_ListCertificates' does not match the response definition in the individual GET operation 'AppServiceCertificateOrders_GetCertificate' . Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L17 |
|
The response in the GET collection operation 'Domains_List' does not match the response definition in the individual GET operation 'Domains_Get' . Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L17 |
|
The response in the GET collection operation 'Domains_ListOwnershipIdentifiers' does not match the response definition in the individual GET operation 'Domains_GetOwnershipIdentifier' . Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L17 |
|
The response in the GET collection operation 'TopLevelDomains_List' does not match the response definition in the individual GET operation 'TopLevelDomains_Get' . Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L17 |
|
The response in the GET collection operation 'AppServiceEnvironments_List' does not match the response definition in the individual GET operation 'AppServiceEnvironments_Get' . Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L17 |
|
The response in the GET collection operation 'AppServiceEnvironments_ListMultiRolePools' does not match the response definition in the individual GET operation 'AppServiceEnvironments_GetMultiRolePool' . Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L17 |
|
The response in the GET collection operation 'AppServiceEnvironments_ListWorkerPools' does not match the response definition in the individual GET operation 'AppServiceEnvironments_GetWorkerPool' . Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L17 |
|
The response in the GET collection operation 'Certificates_List' does not match the response definition in the individual GET operation 'Certificates_Get' . Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L17 |
|
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L671 |
|
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L968 |
|
The nested resource 'HybridConnection' does not have list operation, please add it. Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L1806 |
|
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L2239 |
|
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L3060 |
|
The nested resource 'VnetGateway' does not have list operation, please add it. Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L3986 |
|
The nested resource 'VnetInfoResource' does not have list operation, please add it. Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L4063 |
|
The nested resource 'VnetRoute' does not have list operation, please add it. Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L4080 |
| 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.Web/stable/2022-09-01/CommonDefinitions.json#L125 |
|
| 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.Web/stable/2022-09-01/CommonDefinitions.json#L147 |
|
| 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.Web/stable/2022-09-01/CommonDefinitions.json#L190 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L237 |
|
| 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.Web/stable/2022-09-01/CommonDefinitions.json#L286 |
|
| 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.Web/stable/2022-09-01/CommonDefinitions.json#L291 |
|
| 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.Web/stable/2022-09-01/CommonDefinitions.json#L306 |
|
| 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.Web/stable/2022-09-01/CommonDefinitions.json#L325 |
|
| 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.Web/stable/2022-09-01/CommonDefinitions.json#L334 |
|
| 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.Web/stable/2022-09-01/CommonDefinitions.json#L343 |
|
| 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.Web/stable/2022-09-01/CommonDefinitions.json#L382 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Web/stable/2022-09-01/CommonDefinitions.json#L441 |
|
| 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.Web/stable/2022-09-01/CommonDefinitions.json#L470 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️⌛PR Summary pending [Detail]
Swagger Generation Artifacts
|
Generated ApiView
|
ghost
added
the
This was referenced Jan 29, 2023
Closed
11 tasks
kamperiadis
approved these changes
Feb 8, 2023
3 tasks
jocawtho
reviewed
Feb 9, 2023
specification/web/resource-manager/Microsoft.Web/stable/2022-09-01/CommonDefinitions.json
Outdated
Show resolved
Hide resolved
weidongxu-microsoft
approved these changes
Feb 9, 2023
I think it's used for one of the pipeline test check, seems it restrict to use words only in this file. |
edwin-msft
approved these changes
Feb 9, 2023
edwin-msft
approved these changes
Feb 9, 2023
weidongxu-microsoft
merged commit 69c3bb3
into
Azure:release-web-Microsoft.Web-2022-09-01
3 tasks
3 tasks
6 tasks
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.
Data Plane API - Pull Request
add managedEnvironment to Site schema to support project centauri
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your engagement record.
Is this review for (select one):
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous Open API document (swagger) if applicable, and the root paths that have been updated.
❔Got questions? Need additional info?? We are here to help!
Contact us!
The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links