add managedEnvironment #22298

kaibocai · 2023-01-24T23:44:25Z

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.

Link to engagement record issue:

Is this review for (select one):

a private preview
a public preview
GA release

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.}

Design Document: https://microsoftapc-my.sharepoint.com/:w:/g/personal/raorugan_microsoft_com/EQW2cBdgC0tFnbM6x_0XOygBzPr3P--dbbZ6TDdYKMACNg
Previous Open API Doc:
Updated paths:

❔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.

💬 Teams Channel
💌 email

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Open API validation tools were run on this PR. Go here to see how to fix errors
Spectral Linting
Open API Hub

Guidelines & Specifications

Helpful Links

Azure DevTools Wiki

openapi-workflow-bot · 2023-01-24T23:44:28Z

Hi, @kaibocai Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

openapi-pipeline-app · 2023-01-24T23:44:28Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

compared swaggers (via Oad v0.10.4)]	new version	base version
CommonDefinitions.json	2022-03-01(ddff6ab)	2022-03-01(main)

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v2.0.0)	new version	base version
package-2022-03	package-2022-03(ddff6ab)	package-2022-03(main)

The following errors/warnings exist before current PR submission:

Only 30 items are listed, please refer to log for more details.

Rule	Message
`❌` GetCollectionResponseSchema	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-03-01/CommonDefinitions.json#L17
`❌` GetCollectionResponseSchema	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-03-01/CommonDefinitions.json#L17
`❌` GetCollectionResponseSchema	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-03-01/CommonDefinitions.json#L17
`❌` GetCollectionResponseSchema	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-03-01/CommonDefinitions.json#L17
`❌` GetCollectionResponseSchema	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-03-01/CommonDefinitions.json#L17
`❌` GetCollectionResponseSchema	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-03-01/CommonDefinitions.json#L17
`❌` GetCollectionResponseSchema	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-03-01/CommonDefinitions.json#L17
`❌` GetCollectionResponseSchema	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-03-01/CommonDefinitions.json#L17
`❌` GetCollectionResponseSchema	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-03-01/CommonDefinitions.json#L17
`❌` GuidUsage	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-03-01/CommonDefinitions.json#L671
`❌` ProvisioningStateValidation	ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.Web/stable/2022-03-01/CommonDefinitions.json#L968
`❌` NestedResourcesMustHaveListOperation	The nested resource 'HybridConnection' does not have list operation, please add it. Location: Microsoft.Web/stable/2022-03-01/CommonDefinitions.json#L1806
`❌` GuidUsage	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-03-01/CommonDefinitions.json#L2239
`❌` GuidUsage	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-03-01/CommonDefinitions.json#L3060
`❌` NestedResourcesMustHaveListOperation	The nested resource 'VnetGateway' does not have list operation, please add it. Location: Microsoft.Web/stable/2022-03-01/CommonDefinitions.json#L3948
`❌` NestedResourcesMustHaveListOperation	The nested resource 'VnetInfoResource' does not have list operation, please add it. Location: Microsoft.Web/stable/2022-03-01/CommonDefinitions.json#L4025
`❌` NestedResourcesMustHaveListOperation	The nested resource 'VnetRoute' does not have list operation, please add it. Location: Microsoft.Web/stable/2022-03-01/CommonDefinitions.json#L4042
⚠️ EnumInsteadOfBoolean	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-03-01/CommonDefinitions.json#L125
⚠️ EnumInsteadOfBoolean	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-03-01/CommonDefinitions.json#L147
⚠️ EnumInsteadOfBoolean	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-03-01/CommonDefinitions.json#L190
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Web/stable/2022-03-01/CommonDefinitions.json#L237
⚠️ EnumInsteadOfBoolean	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-03-01/CommonDefinitions.json#L286
⚠️ EnumInsteadOfBoolean	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-03-01/CommonDefinitions.json#L291
⚠️ EnumInsteadOfBoolean	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-03-01/CommonDefinitions.json#L306
⚠️ EnumInsteadOfBoolean	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-03-01/CommonDefinitions.json#L325
⚠️ EnumInsteadOfBoolean	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-03-01/CommonDefinitions.json#L334
⚠️ EnumInsteadOfBoolean	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-03-01/CommonDefinitions.json#L343
⚠️ EnumInsteadOfBoolean	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-03-01/CommonDefinitions.json#L382
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Web/stable/2022-03-01/CommonDefinitions.json#L441
⚠️ EnumInsteadOfBoolean	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-03-01/CommonDefinitions.json#L470

️️✔️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.

️️✔️~[Staging] SwaggerAPIView succeeded [Detail] [Expand]

️️✔️~[Staging] 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: 2 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` HowToFix	Unknown word (containerapp), please fix the error or add words to ./custom-words.txt path: Microsoft.Web/stable/2022-03-01/CommonDefinitions.json#L3083:31
`❌` HowToFix	Unknown word (indentify), please fix the error or add words to ./custom-words.txt path: Microsoft.Web/stable/2022-03-01/CommonDefinitions.json#L3083:74

️️✔️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.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2023-01-24T23:44:29Z