azure-rest-api-specs DMS Swagger Json Review 2021-05-01

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow. Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for this PR by answering the following questions:

What's the purpose of the update?
- [ ] new service onboarding
- [x] new API version
- [ ] update existing version for new feature
- [ ] update existing version to fix swagger quality issue in s360
- [ ] Other, please clarify
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
- [x] SDK of .NET (need service team to ensure code readiness)
- [ ] SDK of Python
- [ ] SDK of Java
- [ ] SDK of Js
- [ ] SDK of Go
- [ ] PowerShell
- [ ] CLI
- [ ] Terraform
- [ ] No refresh required for updates in this PR

Contribution checklist:

[x] I commit to follow the Breaking Change Policy of "no breaking changes"
[x] I have reviewed the documentation for the workflow.
[x] Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: :warning:

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

[x] 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.
- Adding a new service
- Adding new API(s)
- Adding a new API version -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
[x] 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.

[ ] Removing API(s) in a stable version
[ ] Removing properties in a stable version
[ ] Removing API version(s) in a stable version
[ ] Updating API in a stable or public preview version with Breaking Change Validation errors
[ ] Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

Aug 05 '22 06:08 gachauhan

Hi, @gachauhan Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

Aug 05 '22 06:08 openapi-workflow-bot[bot]

Swagger Validation Report

️🔄BreakingChange inProgress [Detail]

️🔄Breaking Change(Cross-Version) inProgress [Detail]

️⌛CredScan pending [Detail]

️️✔️LintDiff succeeded [Detail]

Rule	Message
`❌` LintDiffToolException	"details":""stack":"ParserError: Error parsing /mnt/vss/_work/1/azure-rest-api-specs/specification/hybriddatamanager/resource-manager/Microsoft.HybridData/stable/2021-05-01/hybriddata.json: missed comma between flow collection entries (2169:31)\n\n 2166

️❌Avocado: 2 Errors, 0 Warnings failed [Detail]

Rule Message

❌ JSON_PARSE The file is not a valid JSON file.
json: [Microsoft.HybridData/stable/2021-05-01/hybriddata.json"}]({"kind":"syntax","code":"invalid symbol","position":{"line":2169,"column":30},"token":" ","message":"invalid symbol, token:  , line: 2169, column: 30","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/hybriddatamanager/resource-manager/Microsoft.HybridData/stable/2021-05-01/hybriddata.json"})

❌ MISSING_APIS_IN_DEFAULT_TAG The default tag does not contain all APIs in this RP. Please make sure the missing API swaggers are in the default tag.
readme: specification/hybriddatamanager/resource-manager/readme.md
json: Microsoft.HybridData/stable/2019-06-01/hybriddata.json

Rule	Message
`❌` JSON_PARSE	The file is not a valid JSON file. json: [Microsoft.HybridData/stable/2021-05-01/hybriddata.json"}]({"kind":"syntax","code":"invalid symbol","position":{"line":2169,"column":30},"token":" ","message":"invalid symbol, token:  , line: 2169, column: 30","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/hybriddatamanager/resource-manager/Microsoft.HybridData/stable/2021-05-01/hybriddata.json"})
`❌` MISSING_APIS_IN_DEFAULT_TAG	The default tag does not contain all APIs in this RP. Please make sure the missing API swaggers are in the default tag. readme: specification/hybriddatamanager/resource-manager/readme.md json: Microsoft.HybridData/stable/2019-06-01/hybriddata.json

️🔄ApiReadinessCheck inProgress [Detail]

️❌ModelValidation: 0 Errors, 0 Warnings failed [Detail]

️❌SemanticValidation: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` JSON_PARSING_ERROR	Json parsing error: invalid symbol JsonUrl: Microsoft.HybridData/stable/2021-05-01/hybriddata.json#L2169:30

️⌛PoliCheck pending [Detail]

️❌SDK Track2 Validation: 0 Errors, 0 Warnings failed [Detail]

️❌PrettierCheck: 62 Errors, 0 Warnings failed [Detail]

Only 30 items are listed, please refer to log for more details.

Rule	Message
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataManagers_Create-PUT-example-41.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataManagers_Delete-DELETE-example-41.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataManagers_Get-GET-example-41.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataManagers_List-GET-example-21.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataManagers_ListByResourceGroup-GET-example-31.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataManagers_Update-PATCH-example-43.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataServices_Get-GET-example-51.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataServices_Get-GET-example-62.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataServices_Get-GET-example-63.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataServices_Get-GET-example-64.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataServices_Get-GET-example-65.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataServices_Get-GET-example-66.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataServices_Get-GET-example-67.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataServices_Get-GET-example-68.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataServices_ListByDataManager-GET-example-51.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataStoreTypes_Get-GET-example-201.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataStoreTypes_Get-GET-example-212.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataStoreTypes_Get-GET-example-213.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataStoreTypes_Get-GET-example-214.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataStoreTypes_Get-GET-example-215.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataStoreTypes_Get-GET-example-216.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataStoreTypes_Get-GET-example-217.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataStoreTypes_ListByDataManager-GET-example-201.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataStores_CreateOrUpdate_DataSink-GET-example-194.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataStores_CreateOrUpdate_DataSink-GET-example-195.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataStores_CreateOrUpdate_DataSink-GET-example-241.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataStores_CreateOrUpdate_DataSink-PUT-example-192.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataStores_CreateOrUpdate_DataSource-GET-example-194.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataStores_CreateOrUpdate_DataSource-GET-example-195.json
`❌` HowToFix	Code style issues found path: stable/2021-05-01/examples/DataStores_CreateOrUpdate_DataSource-GET-example-241.json

️❌SpellCheck: 4 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` HowToFix	Unknown word (retryjob), please fix the error or add words to ./custom-words.txt path: Microsoft.HybridData/stable/2021-05-01/hybriddata.json#L1128:201
`❌` HowToFix	Unknown word (skipjob), please fix the error or add words to ./custom-words.txt path: Microsoft.HybridData/stable/2021-05-01/hybriddata.json#L1259:201
`❌` HowToFix	Unknown word (usgovtexas), please fix the error or add words to ./custom-words.txt path: Microsoft.HybridData/stable/2021-05-01/hybriddata.json#L2688:14
`❌` HowToFix	Unknown word (usgovvirginia), please fix the error or add words to ./custom-words.txt path: Microsoft.HybridData/stable/2021-05-01/hybriddata.json#L2689:14

️️✔️Lint(RPaaS) succeeded [Detail]

Rule	Message
`❌` LintRpaasToolException	"details":""stack":"ParserError: Error parsing /mnt/vss/_work/1/azure-rest-api-specs/specification/hybriddatamanager/resource-manager/Microsoft.HybridData/stable/2021-05-01/hybriddata.json: missed comma between flow collection entries (2169:31)\n\n 2166

️⌛CadlValidation pending [Detail]

_{Posted by Swagger Pipeline | How to fix these errors?}

Aug 05 '22 06:08 openapi-pipeline-app[bot]