Merge Microsoft.App-2022-03-01 to main branch #18331
Closed
Conversation
This file contains hidden or 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
…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 <[email protected]>
|
Hi, @Juliehzl 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] |
|
[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 new version is missing a property found in the old version. Was 'dockerfilePath' renamed or removed? New: Microsoft.App/preview/2022-01-01-preview/SourceControls.json#L312:7 Old: Microsoft.App/preview/2022-01-01-preview/SourceControls.json#L312:7 |
|
The new version has a new property 'contextPath' in response that was not found in the old version. New: Microsoft.App/preview/2022-01-01-preview/SourceControls.json#L312:7 Old: Microsoft.App/preview/2022-01-01-preview/SourceControls.json#L312:7 |
|
The new version has a new property 'image' in response that was not found in the old version. New: Microsoft.App/preview/2022-01-01-preview/SourceControls.json#L312:7 Old: Microsoft.App/preview/2022-01-01-preview/SourceControls.json#L312:7 |
️⚠️LintDiff: 8 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.12.1 , classic-openapi-validator v1.2.2 )
- Linted configuring files (Based on target branch, openapi-validator v1.12.1 , classic-openapi-validator v1.2.2 )
| 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#L385 |
|
| 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#L492 |
|
| 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#L842 |
|
| 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#L573 |
|
| 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#L609 |
|
| 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#L652 |
|
| 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#L725 |
|
| 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#L851 |
|
| 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#L281 |
|
| 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, 'sourcecontrols' with immediate parent 'ContainerApp', must have a list by immediate parent operation. Location: Microsoft.App/preview/2022-01-01-preview/SourceControls.json#L264 |
|
| 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#L554 |
|
| 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#L558 |
|
| 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#L669 |
|
| 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 succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
- 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
|
|
NewApiVersionRequired reason: |
|
Hi @Juliehzl, 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. |
Contributor
Author
|
Hi @msyyc , for breaking changes, you could see description in the PR #18137. @JeffreyRichter Could you help review the breaking change? |
Juliehzl
added
the
WaitForARMFeedback
Contributor
|
There are some issues with this PR. closing it. |
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.
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.
-[ ] 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.