-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Adding Microsoft.App stable version 2022-03-01 #18356
Conversation
…preview to version 2022-03-01
* Copy updated AuthConfig from previous version * Add suppression
* add API * update * fix * update * update
* Add label property * fix prettier Co-authored-by: Juliehzl <zuh@microsoft.com>
Hi, @ruslany 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 |
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Validation Report
|
Rule | Message |
---|---|
The child tracked resource, 'revisions' with immediate parent 'ContainerApp', must have a list by immediate parent operation. Location: Microsoft.App/stable/2022-03-01/ContainerAppsRevisions.json#L393 |
|
The child tracked resource, 'replicas' with immediate parent 'Revision', must have a list by immediate parent operation. Location: Microsoft.App/stable/2022-03-01/ContainerAppsRevisions.json#L500 |
|
The child tracked resource, 'certificates' with immediate parent 'ManagedEnvironment', must have a list by immediate parent operation. Location: Microsoft.App/stable/2022-03-01/ManagedEnvironments.json#L827 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.App/stable/2022-03-01/ContainerApps.json#L558 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: external Location: Microsoft.App/stable/2022-03-01/ContainerApps.json#L594 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: allowInsecure Location: Microsoft.App/stable/2022-03-01/ContainerApps.json#L637 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: latestRevision Location: Microsoft.App/stable/2022-03-01/ContainerApps.json#L710 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.App/stable/2022-03-01/Global.json#L85 |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/stable/2022-03-01/ManagedEnvironments.json#L836 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/stable/2022-03-01/ManagedEnvironmentsStorages.json#L290 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.App/stable/2022-03-01/CommonDefinitions.json#L1 |
|
The summary and description values should not be same. Location: Microsoft.App/stable/2022-03-01/ManagedEnvironmentsStorages.json#L19 |
|
The summary and description values should not be same. Location: Microsoft.App/stable/2022-03-01/ManagedEnvironmentsStorages.json#L66 |
|
The summary and description values should not be same. Location: Microsoft.App/stable/2022-03-01/ManagedEnvironmentsStorages.json#L118 |
|
The summary and description values should not be same. Location: Microsoft.App/stable/2022-03-01/ManagedEnvironmentsStorages.json#L179 |
|
Based on the response model schema, operation 'ContainerAppsRevisionReplicas_ListReplicas' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.App/stable/2022-03-01/ContainerAppsRevisions.json#L289 |
|
Based on the response model schema, operation 'ManagedEnvironmentsStorages_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.App/stable/2022-03-01/ManagedEnvironmentsStorages.json#L19 |
|
The child tracked resource, 'authConfigs' with immediate parent 'ContainerApp', must have a list by immediate parent operation. Location: Microsoft.App/stable/2022-03-01/AuthConfigs.json#L256 |
|
The child tracked resource, 'daprComponents' with immediate parent 'ManagedEnvironment', must have a list by immediate parent operation. Location: Microsoft.App/stable/2022-03-01/DaprComponents.json#L258 |
|
The child tracked resource, 'storages' with immediate parent 'ManagedEnvironment', must have a list by immediate parent operation. Location: Microsoft.App/stable/2022-03-01/ManagedEnvironmentsStorages.json#L281 |
|
The child tracked resource, 'sourcecontrols' with immediate parent 'ContainerApp', must have a list by immediate parent operation. Location: Microsoft.App/stable/2022-03-01/SourceControls.json#L264 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: ready Location: Microsoft.App/stable/2022-03-01/ContainerAppsRevisions.json#L562 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: started Location: Microsoft.App/stable/2022-03-01/ContainerAppsRevisions.json#L566 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: internal Location: Microsoft.App/stable/2022-03-01/ManagedEnvironments.json#L667 |
|
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: List environments storages by subscription Location: Microsoft.App/stable/2022-03-01/ManagedEnvironmentsStorages.json#L225 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌
~[Staging] ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
API Readiness check failed. Please make sure your service is deployed. |
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.App' for api version '2022-03-01'. The supported api-versions are '2022-01-01-preview'." |
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️
Cross-Version Breaking Changes: 13 Warnings warning [Detail]
- Compared Swaggers (Based on Oad v0.9.3)
- current:stable/2022-03-01/AuthConfigs.json compared with base:preview/2022-01-01-preview/AuthConfigs.json
- current:stable/2022-03-01/CommonDefinitions.json compared with base:preview/2022-01-01-preview/CommonDefinitions.json
- current:stable/2022-03-01/ContainerApps.json compared with base:preview/2022-01-01-preview/ContainerApps.json
- current:stable/2022-03-01/ContainerAppsRevisions.json compared with base:preview/2022-01-01-preview/ContainerAppsRevisions.json
- current:stable/2022-03-01/DaprComponents.json compared with base:preview/2022-01-01-preview/DaprComponents.json
- current:stable/2022-03-01/Global.json compared with base:preview/2022-01-01-preview/Global.json
- current:stable/2022-03-01/ManagedEnvironments.json compared with base:preview/2022-01-01-preview/ManagedEnvironments.json
- current:stable/2022-03-01/ManagedEnvironmentsStorages.json compared with base:preview/2022-01-01-preview/ManagedEnvironmentsStorages.json
- current:stable/2022-03-01/SourceControls.json compared with base:preview/2022-01-01-preview/SourceControls.json
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️
SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️
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).
Swagger Generation Artifacts
|
@msyyc - please note that this is not a breaking change. There was already a merged PR to main branch before that included changes to the specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/AuthConfigs.json. For some reason this PR still shows that those changes are not there. |
* Updating patch spec. * Fix linter * prettier fix * Adding x-ms-long-running-operation Co-authored-by: Ruslan Yakushev 🚴 <1664475+ruslany@users.noreply.github.com>
* Adds base for updating Microsoft.App from version preview/2022-01-01-preview to version 2022-03-01 * Updates readme * Updates API version in new specs and examples * refactore properties (#18137) * [Non Break Change]Update to use easy auth v2 same as Web App (#18143) (#18217) * Update auth config to use the same auth config in App Service * Update for spell check * Remove TokenStore/ConfigFilePath as not supported for ContainerApp * Copy AuthConfig from previous version (#18221) * Copy updated AuthConfig from previous version * Add suppression * Add API for checkNameAvailability in 2022-03-01 (#18204) * add API * update * fix * update * update * Add label property (#18280) * Add label property * fix prettier Co-authored-by: Juliehzl <zuh@microsoft.com> * refactor sc properties in 03-01 (#18343) * refactor sc properties in 03-01 * Revert "refactore properties (#18137)" This reverts commit 4fe86bc. * add odata query (#18364) * Updating patch spec. (#18354) * Updating patch spec. * Fix linter * prettier fix * Adding x-ms-long-running-operation Co-authored-by: Ruslan Yakushev 🚴 <1664475+ruslany@users.noreply.github.com> Co-authored-by: Xingjian Wang <79332479+xwang971@users.noreply.github.com> Co-authored-by: erich-wang <eriwan@microsoft.com> Co-authored-by: Zunli Hu <zuh@microsoft.com> Co-authored-by: Michael Dai <michaelkira@live.cn> Co-authored-by: Vaclav Turecek <vturecek@microsoft.com>
* Adds base for updating Microsoft.App from version preview/2022-01-01-preview to version 2022-03-01 * Updates readme * Updates API version in new specs and examples * refactore properties (Azure#18137) * [Non Break Change]Update to use easy auth v2 same as Web App (Azure#18143) (Azure#18217) * Update auth config to use the same auth config in App Service * Update for spell check * Remove TokenStore/ConfigFilePath as not supported for ContainerApp * Copy AuthConfig from previous version (Azure#18221) * Copy updated AuthConfig from previous version * Add suppression * Add API for checkNameAvailability in 2022-03-01 (Azure#18204) * add API * update * fix * update * update * Add label property (Azure#18280) * Add label property * fix prettier Co-authored-by: Juliehzl <zuh@microsoft.com> * refactor sc properties in 03-01 (Azure#18343) * refactor sc properties in 03-01 * Revert "refactore properties (Azure#18137)" This reverts commit 4fe86bc. * add odata query (Azure#18364) * Updating patch spec. (Azure#18354) * Updating patch spec. * Fix linter * prettier fix * Adding x-ms-long-running-operation Co-authored-by: Ruslan Yakushev 🚴 <1664475+ruslany@users.noreply.github.com> Co-authored-by: Xingjian Wang <79332479+xwang971@users.noreply.github.com> Co-authored-by: erich-wang <eriwan@microsoft.com> Co-authored-by: Zunli Hu <zuh@microsoft.com> Co-authored-by: Michael Dai <michaelkira@live.cn> Co-authored-by: Vaclav Turecek <vturecek@microsoft.com>
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist:
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 label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[X] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.