-
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
add x-ms-enum for enum param #19654
add x-ms-enum for enum param #19654
Conversation
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. vscswagger@microsoft.com |
Swagger Validation Report
|
compared swaggers (via Oad v0.9.6)] | new version | base version |
---|---|---|
Provider.json | 2021-03-01(ae9d8a8) | 2021-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-2021-03 | package-2021-03(ae9d8a8) | package-2021-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/2021-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 |
---|---|
The summary and description values should not be same. Location: Microsoft.Web/stable/2021-03-01/Provider.json#L19 |
|
The summary and description values should not be same. Location: Microsoft.Web/stable/2021-03-01/Provider.json#L54 |
|
The summary and description values should not be same. Location: Microsoft.Web/stable/2021-03-01/Provider.json#L94 |
|
The summary and description values should not be same. Location: Microsoft.Web/stable/2021-03-01/Provider.json#L141 |
|
The summary and description values should not be same. Location: Microsoft.Web/stable/2021-03-01/Provider.json#L188 |
|
The summary and description values should not be same. Location: Microsoft.Web/stable/2021-03-01/Provider.json#L225 |
|
The summary and description values should not be same. Location: Microsoft.Web/stable/2021-03-01/Provider.json#L265 |
|
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/2021-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/2021-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/2021-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/2021-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/2021-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/2021-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/2021-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/2021-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/2021-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/2021-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/2021-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/2021-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/2021-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/2021-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/2021-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/2021-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/2021-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/2021-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/2021-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/2021-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/2021-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/2021-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/2021-03-01/Provider.json#L794 |
️️✔️
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: 14 Warnings warning [Detail]
- The following tags are being changed in this PR
Rule | Message |
---|---|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > AppServiceCertificatePatchResource > properties > properties)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > AppServiceCertificateResource > properties > properties)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > AppServiceEnvironmentPatchResource > properties > properties)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > AppServiceEnvironmentResource > properties > properties)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > PrivateLinkConnectionApprovalRequestResource > properties > properties)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > VnetInfoResource > properties > properties)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > DetectorDefinitionResource > properties > properties)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > ApplicationStackResource > properties > properties)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > StaticSiteARMResource > properties > properties)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > StaticSitePatchResource > properties > properties)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > StaticSiteZipDeploymentARMResource > properties > properties)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > MSDeploy > properties > properties)\n keys: [ \u001b[32m'type'\u001b[39m, \u001b[32m'properties'\u001b[39m ]" |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > SiteConfigResource > properties > properties)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > SlotConfigNamesResource > properties > properties)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
💬 | "readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0 -> 1.11.0)" |
💬 | "readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0->1.11.0)" |
💬 | "readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"> Installing AutoRest extension '@autorest/modelerfour' (4.21.4 -> 4.21.4)" |
💬 | "readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"> Installed AutoRest extension '@autorest/modelerfour' (4.21.4->4.21.4)" |
💬 | "readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Autorest completed in 35.73s. 0 files generated." |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.0.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.1.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.2.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.3.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.4.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.5.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.6.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.7.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.8.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.9.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.10.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.11.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.12.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.13.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.14.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.15.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.16.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.17.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.18.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.19.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.20.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.21.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.22.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.23.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.24.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.25.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.26.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.27.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.28.suppress which is deprecated and will be removed in the future." |
|
"readme":"web/resource-manager/readme.md", "tag":"package-2021-03", "details":"Using directive.29.suppress which is deprecated and will be removed in the future." |
️️✔️
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
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
change already in 2021-02-01 (but not 2021-03-01)
@naveedaz Could you help to have a review? |
Hi @naveedaz, would you take a look and sign-off? |
Sync 'x-ms-enum' fix to the latest API version.
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.