Sync x-mx-enum change from 2021-03-01 #19728
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, @tadelesh 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] |
Swagger Validation Report
|
| compared swaggers (via Oad v0.9.6)] | new version | base version |
|---|---|---|
| Provider.json | 2022-03-01(1576cfe) | 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: 1 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2022-03 | package-2022-03(1576cfe) | package-2022-03(main) |
The following errors/warnings are introduced by current PR:
| Rule | Message |
|---|---|
| 'osTypeSelected' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Web/stable/2022-03-01/Provider.json#L1072 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isSupported Location: Microsoft.Web/stable/2022-03-01/Provider.json#L308 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDefaultOff Location: Microsoft.Web/stable/2022-03-01/Provider.json#L313 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: remoteDebuggingSupported Location: Microsoft.Web/stable/2022-03-01/Provider.json#L463 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isPreview Location: Microsoft.Web/stable/2022-03-01/Provider.json#L499 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDeprecated Location: Microsoft.Web/stable/2022-03-01/Provider.json#L504 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isHidden Location: Microsoft.Web/stable/2022-03-01/Provider.json#L509 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isAutoUpdate Location: Microsoft.Web/stable/2022-03-01/Provider.json#L520 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isEarlyAccess Location: Microsoft.Web/stable/2022-03-01/Provider.json#L525 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDefault Location: Microsoft.Web/stable/2022-03-01/Provider.json#L530 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isSupported Location: Microsoft.Web/stable/2022-03-01/Provider.json#L635 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isPreview Location: Microsoft.Web/stable/2022-03-01/Provider.json#L661 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDeprecated Location: Microsoft.Web/stable/2022-03-01/Provider.json#L666 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isHidden Location: Microsoft.Web/stable/2022-03-01/Provider.json#L671 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isAutoUpdate Location: Microsoft.Web/stable/2022-03-01/Provider.json#L682 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isEarlyAccess Location: Microsoft.Web/stable/2022-03-01/Provider.json#L687 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: use32BitWorkerProcess Location: Microsoft.Web/stable/2022-03-01/Provider.json#L698 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDefault Location: Microsoft.Web/stable/2022-03-01/Provider.json#L732 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: applicationInsights Location: Microsoft.Web/stable/2022-03-01/Provider.json#L746 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isPreview Location: Microsoft.Web/stable/2022-03-01/Provider.json#L750 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDeprecated Location: Microsoft.Web/stable/2022-03-01/Provider.json#L754 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isHidden Location: Microsoft.Web/stable/2022-03-01/Provider.json#L758 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDefault Location: Microsoft.Web/stable/2022-03-01/Provider.json#L790 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isRemoteDebuggingEnabled Location: Microsoft.Web/stable/2022-03-01/Provider.json#L794 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: remoteDebuggingSupported Location: Microsoft.Web/stable/2022-03-01/Provider.json#L857 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isPreview Location: Microsoft.Web/stable/2022-03-01/Provider.json#L872 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDeprecated Location: Microsoft.Web/stable/2022-03-01/Provider.json#L877 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isHidden Location: Microsoft.Web/stable/2022-03-01/Provider.json#L882 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isAutoUpdate Location: Microsoft.Web/stable/2022-03-01/Provider.json#L893 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isEarlyAccess Location: Microsoft.Web/stable/2022-03-01/Provider.json#L898 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isPreview Location: Microsoft.Web/stable/2022-03-01/Provider.json#L1023 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck 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.
️⚠️SDK Track2 Validation: 3 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/1576cfe3acae822a9d732e37490eeb9959f81459/specification/web/resource-manager/readme.md#tag-package-2022-03">web/resource-manager/readme.md#package-2022-03
| Rule | Message |
|---|---|
| "readme":"web/resource-manager/readme.md", "tag":"package-2022-03", "details":"The schema 'ExpressionTraces-value' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2022-03-01/WebApps.json#/components/schemas/ExpressionTraces-value" |
|
| "readme":"web/resource-manager/readme.md", "tag":"package-2022-03", "details":"The schema 'Expression-value' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2022-03-01/WebApps.json#/components/schemas/Expression-value" |
|
| "readme":"web/resource-manager/readme.md", "tag":"package-2022-03", "details":"The schema 'OperationResultProperties-error' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2022-03-01/WebApps.json#/components/schemas/OperationResultProperties-error" |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| "readme":"web/resource-manager/readme.md", "tag":"package-2022-03", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
️️✔️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.
Swagger Generation Artifacts
|
This was referenced Jul 11, 2022
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
weidongxu-microsoft
approved these changes
Jul 12, 2022
This was referenced Jul 12, 2022
Closed
Closed
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.
Already approved from #19654.
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 appy 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 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.