-
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
[ProviderHub] S360 linter issue #19067
Conversation
Swagger Validation Report
|
Rule | Message |
---|---|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L2317 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L2585 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L3538 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L3630 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L3966 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L4408 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L4679 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Operations_CreateOrUpdate' Request Model: 'OperationsPutContent' Response Model: 'OperationsContent' Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L769 |
|
200/201 Responses of long running operations must have a schema definition for return type. OperationId: 'ProviderRegistrations_CreateOrUpdate', Response code: '201' Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L941 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L2825 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L3318 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isCheckedIn Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L3436 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L3597 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: preflightSupported Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L3806 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L4034 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableDefaultValidation Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L4141 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: validationRequired Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L4155 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: crossResourceGroupMoveEnabled Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L4158 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: crossSubscriptionMoveEnabled Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L4161 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableAsyncOperation Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L4286 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableThirdPartyS2S Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L4311 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isPureProxy Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L4321 |
|
The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L7 |
|
'TrafficRegions' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L2141 |
|
'regions' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L2144 |
|
'CustomRolloutSpecification' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L2152 |
|
'canary' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L2158 |
|
'providerRegistration' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L2165 |
|
'resourceTypeRegistrations' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L2172 |
|
'TypedErrorInfo' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L2180 |
️️✔️
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.
️️✔️
Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️
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).
Hi @wwendyc, this service has enabled Shift Left. All spec updates MUST be initiated from service ADO project repo, so that to guarantee it to be the source of truth. |
Swagger Generation Artifacts
|
Hi, @wwendyc 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 |
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.
Indent should be 2 spaces. Can you revert it? It's hard to see the diff against previous version.~
Pls follow the ci fix instructions to fix |
As synced offline to publish this change by shift left pipeline. |
* x-ms-enum linter and prettier formatting * formatting * prettier Co-authored-by: Wendy Chang <wendychang@gmail.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 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.