Fix swagger linting issues #11886

anrudraw · 2020-12-02T00:40:38Z

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Please ensure to add changelog with this PR by answering the following questions.

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
- 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, no need to refresh for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of “no breaking changes
I have reviewed the documentation for the workflow.
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

Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
- Adding new API(s)
- Adding a new API version
- Adding a new service
Please 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 there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.

Removing API(s) in stable version
Removing properties in stable version
Removing API version(s) in stable version
Updating API in stable version with Breaking Change Validation errors
Updating API(s) in preview over 1 year

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.

openapi-pipeline-app · 2020-12-02T00:40:42Z

Swagger Validation Report

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

Compared Swaggers (Based on Oad v0.8.1)
- original: stable/2020-03-30/healthcare-apis.json <---> new: stable/2020-03-30/healthcare-apis.json

Rule	Message
`❌` 1023 - TypeFormatChanged	The new version has a different format than the previous one. New: Microsoft.HealthcareApis/stable/2020-03-30/healthcare-apis.json#L819:9 Old: Microsoft.HealthcareApis/stable/2020-03-30/healthcare-apis.json#L819:9
`❌` 1023 - TypeFormatChanged	The new version has a different format than the previous one. New: Microsoft.HealthcareApis/stable/2020-03-30/healthcare-apis.json#L883:9 Old: Microsoft.HealthcareApis/stable/2020-03-30/healthcare-apis.json#L882:9
`❌` 1023 - TypeFormatChanged	The new version has a different format than the previous one. New: Microsoft.HealthcareApis/stable/2020-03-30/healthcare-apis.json#L819:9 Old: Microsoft.HealthcareApis/stable/2020-03-30/healthcare-apis.json#L819:9
`❌` 1023 - TypeFormatChanged	The new version has a different format than the previous one. New: Microsoft.HealthcareApis/stable/2020-03-30/healthcare-apis.json#L883:9 Old: Microsoft.HealthcareApis/stable/2020-03-30/healthcare-apis.json#L882:9

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

Linted configuring files (Based on source branch, openapi-validator v1.6.0 , classic-openapi-validator v1.1.5 )
- healthcareapis/resource-manager/readme.md tag:package-2020-03-30
Linted configuring files (Based on target branch, openapi-validator v1.6.0 , classic-openapi-validator v1.1.5 )
- healthcareapis/resource-manager/readme.md tag:package-2020-03-30

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

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

openapi-pipeline-app · 2020-12-02T00:40:43Z

Swagger Generation Artifacts

️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 80f0a08. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-5.0
command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/healthcareapis/resource-manager/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied

️✔️Microsoft.Azure.Management.HealthcareApis [View full logs] [Release SDK Changes]
- Microsoft.Azure.Management.HealthcareApis.3.0.0.nupkg
- Microsoft.Azure.Management.HealthcareApis.3.0.0.snupkg

️⚠️ azure-sdk-for-python warning [Detail]

⚠️Warning [Logs]Release - Generate from 80f0a08. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] Ignoring mock: markers 'python_version <= "2.7"' don't match your environment
cmderr	[automation_init.sh]   Failed building wheel for ConfigArgParse
cmderr	[automation_init.sh]   Failed building wheel for wrapt
cmderr	[automation_init.sh]   Failed building wheel for yarl
cmderr	[automation_init.sh]   Failed building wheel for multidict
cmderr	[automation_init.sh] Cannot uninstall requirement azure-nspkg, not installed
cmderr	[automation_init.sh] Command '['/home/vsts/work/1/s/azure-sdk-for-python_tmp/venv-sdk/bin/python', '-m', 'pip', 'uninstall', '-y', 'azure-nspkg']' returned non-zero exit status 1.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json

️✔️azure-mgmt-healthcareapis [View full logs] [Release SDK Changes]

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Model ServicesDescription has a new parameter system_data
info	[Changelog]   - Model ServicesProperties has a new parameter acr_configuration

️⚠️ azure-sdk-for-java warning [Detail]

⚠️Warning [Logs]Release - Generate from 80f0a08. SDK Automation 14.0.0

command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
cmderr	[generate.py] 2021-01-29 05:30:44 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-healthcareapis"
cmderr	[generate.py] 2021-01-29 05:30:44 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
cmderr	[generate.py] 2021-01-29 05:30:44 INFO autorest --version=3.0.6350 --use=@autorest/java@4.0.11 --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/healthcareapis/azure-resourcemanager-healthcareapis --java.namespace=com.azure.resourcemanager.healthcareapis   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/healthcareapis/resource-manager/readme.md
cmderr	[generate.py] 2021-01-29 05:31:29 INFO [CI][Success] Write to ci.yml
cmderr	[generate.py] 2021-01-29 05:31:29 INFO [POM][Process] dealing with pom.xml
cmderr	[generate.py] 2021-01-29 05:31:29 INFO [POM][Skip] pom already has module azure-resourcemanager-healthcareapis
cmderr	[generate.py] 2021-01-29 05:31:29 INFO [POM][Success] Write to pom.xml
cmderr	[generate.py] 2021-01-29 05:31:29 INFO [POM][Process] dealing with root pom
cmderr	[generate.py] 2021-01-29 05:31:29 INFO [POM][Success] Write to root pom
cmderr	[generate.py] WARNING: An illegal reflective access operation has occurred
cmderr	[generate.py] WARNING: Illegal reflective access by org.codehaus.groovy.reflection.ReflectionUtils (file:/home/vsts/.m2/repository/org/codehaus/groovy/groovy/3.0.0-beta-2/groovy-3.0.0-beta-2-indy.jar) to method java.util.Collections$UnmodifiableCollection.toString()
cmderr	[generate.py] WARNING: Please consider reporting this to the maintainers of org.codehaus.groovy.reflection.ReflectionUtils
cmderr	[generate.py] WARNING: Use --illegal-access=warn to enable warnings of further illegal reflective access operations
cmderr	[generate.py] WARNING: All illegal access operations will be denied in a future release

️✔️azure-resourcemanager-healthcareapis [View full logs] [Release SDK Changes]

cmderr	[Inst] 2021-01-29 05:34:58 DEBUG Got artifact_id: azure-resourcemanager-healthcareapis
cmderr	[Inst] 2021-01-29 05:34:58 DEBUG Got artifact: pom.xml
cmderr	[Inst] 2021-01-29 05:34:58 DEBUG Got artifact: azure-resourcemanager-healthcareapis-1.0.0-beta.1-sources.jar
cmderr	[Inst] 2021-01-29 05:34:58 DEBUG Got artifact: azure-resourcemanager-healthcareapis-1.0.0-beta.1.jar
cmderr	[Inst] 2021-01-29 05:34:58 DEBUG Match jar package: azure-resourcemanager-healthcareapis-1.0.0-beta.1.jar
cmderr	[Inst] 2021-01-29 05:34:58 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/11886/azure-sdk-for-java/azure-resourcemanager-healthcareapis/azure-resourcemanager-healthcareapis-1.0.0-beta.1.jar\" -o azure-resourcemanager-healthcareapis-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-healthcareapis -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-healthcareapis-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
```"}

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 80f0a08. SDK Automation 14.0.0

command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️healthcareapis/mgmt/2020-03-30/healthcareapis [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```
️✔️healthcareapis/mgmt/2020-03-15/healthcareapis [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```
️✔️healthcareapis/mgmt/2019-09-16/healthcareapis [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```
️✔️preview/healthcareapis/mgmt/2018-08-20-preview/healthcareapis [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 80f0a08. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/healthcareapis/resource-manager/readme.md

️✔️@azure/arm-healthcareapis [View full logs] [Release SDK Changes]

azure-arm-healthcareapis-1.0.0.tgz

cmderr	[npmPack] loaded rollup.config.js with warnings
cmderr	[npmPack] (!) Unused external imports
cmderr	[npmPack] default imported from external module 'rollup' but never used
cmderr	[npmPack] ./esm/healthcareApisManagementClient.js → ./dist/arm-healthcareapis.js...
cmderr	[npmPack] created ./dist/arm-healthcareapis.js in 332ms

️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 80f0a08. Schema Automation 14.0.0

warn	Skip initScript due to not configured
command	npx n 12
command	autorest --use=@autorest/azureresourceschema@3.0.92 --version=3.0.6369 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/healthcareapis/resource-manager/readme.md

️✔️healthcareapis [View full logs] [Release Schema Changes]

cmderr	[resource-manager] node-pre-gyp
cmderr	[resource-manager] WARN Using request for node-pre-gyp https download
cmderr	[resource-manager]  WARN template-schema-validation-tools@1.0.0 No repository field.
cmderr	[resource-manager] WARN optional SKIPPING OPTIONAL DEPENDENCY: fsevents@2.1.3 (node_modules/fsevents):
cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.3: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})

️🔄 azure-resource-manager-schemas inProgress [Detail]

️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

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

openapi-workflow-bot · 2020-12-02T00:42:51Z

Hi @anrudraw, 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.
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.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ma/swaggerfeedback.

ArcturusZhang · 2020-12-02T06:15:46Z

/azp run

azure-pipelines · 2020-12-02T06:16:01Z

Azure Pipelines successfully started running 2 pipeline(s).

erich-wang · 2020-12-04T08:56:38Z

Will review this PR after removing label NotReadyForReview

anrudraw · 2020-12-11T19:53:13Z

@erich-wang forgot to remove the "NotReadyForReview" label. Removed it now and PR is ready for the review. I'm not sure why this fix for s360 reporting breaking change.

openapi-workflow-bot · 2020-12-14T01:50:18Z

Hi @anrudraw, 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.
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.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ma/swaggerfeedback.

erich-wang · 2020-12-18T05:15:22Z

@anrudraw , you're adding format which narrows down allowed accepted integer value, this is breaking change.

ghost · 2021-01-03T16:01:47Z

Hi, @anrudraw. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

anrudraw · 2021-01-05T23:06:14Z

@erich-wang makes sense. I just added the format based on recommendation provided in the s360 report. Is there a process i would need to follow to get this PR approved?

erich-wang · 2021-01-06T05:51:31Z

@anrudraw , you just need to follow :
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.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

anrudraw · 2021-01-12T22:50:23Z

@erich-wang I think this breaking change is false positive. The format that I added for the 2 parameters, their max allowed integer value is already within int32 range. I tried accessing this link: https://aka.ma/swaggerfeedback but getting internal server error.

erich-wang · 2021-01-18T06:02:22Z

@anrudraw , the correct link should be https://aka.ms/swaggerfeedback, sorry for the typo.

* Fixing swagger linting issues * Updated int type and patch call response * updated example * Removed update to patch call response * Removed response code from swagger spec

Fixing swagger linting issues

f28ae33

openapi-assignment-bot bot assigned erich-wang Dec 2, 2020

openapi-pipeline-app bot added the BreakingChangeReviewRequired label Dec 2, 2020

This was referenced Dec 2, 2020

[AutoPR @azure/arm-healthcareapis] Fix swagger linting issues AzureSDKAutomation/azure-sdk-for-js#2806

Closed

[AutoPR azure-mgmt-healthcareapis] Fix swagger linting issues AzureSDKAutomation/azure-sdk-for-python#3149

Closed

anrudraw added the NotReadyForReview <valid label in PR review process>It is in draft for swagger or not swagger PR label Dec 2, 2020

Updated int type and patch call response

15c7e61

updated example

6558749

anrudraw removed the NotReadyForReview <valid label in PR review process>It is in draft for swagger or not swagger PR label Dec 11, 2020

anrudraw added 2 commits December 11, 2020 11:01

Removed update to patch call response

0f77e13

Removed response code from swagger spec

4e7d259

openapi-pipeline-app bot added CI-BreakingChange-Python and removed BreakingChangeReviewRequired labels Dec 11, 2020

openapi-sdkautomation bot mentioned this pull request Dec 11, 2020

[AutoPR azure-resourcemanager-healthcareapis] Fix swagger linting issues AzureSDKAutomation/azure-sdk-for-java#6966

Closed

erich-wang added the BreakingChangeReviewRequired label Dec 14, 2020

ghost added the no-recent-activity label Jan 3, 2021

erich-wang approved these changes Jan 6, 2021

View reviewed changes

erich-wang added the linter-issues label Jan 6, 2021

ghost removed the no-recent-activity label Jan 6, 2021

erich-wang added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jan 29, 2021

erich-wang merged commit 80f0a08 into Azure:master Jan 29, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix swagger linting issues #11886

Fix swagger linting issues #11886

anrudraw commented Dec 2, 2020

openapi-pipeline-app bot commented Dec 2, 2020 •

edited

Loading

openapi-pipeline-app bot commented Dec 2, 2020 •

edited

Loading

openapi-workflow-bot bot commented Dec 2, 2020

ArcturusZhang commented Dec 2, 2020

azure-pipelines bot commented Dec 2, 2020

erich-wang commented Dec 4, 2020

anrudraw commented Dec 11, 2020

openapi-workflow-bot bot commented Dec 14, 2020

erich-wang commented Dec 18, 2020

ghost commented Jan 3, 2021

anrudraw commented Jan 5, 2021

erich-wang commented Jan 6, 2021 •

edited by ruowan

Loading

anrudraw commented Jan 12, 2021

erich-wang commented Jan 18, 2021

Fix swagger linting issues #11886

Fix swagger linting issues #11886

Conversation

anrudraw commented Dec 2, 2020

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-pipeline-app bot commented Dec 2, 2020 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Dec 2, 2020 • edited Loading

Swagger Generation Artifacts

openapi-workflow-bot bot commented Dec 2, 2020

ArcturusZhang commented Dec 2, 2020

azure-pipelines bot commented Dec 2, 2020

erich-wang commented Dec 4, 2020

anrudraw commented Dec 11, 2020

openapi-workflow-bot bot commented Dec 14, 2020

erich-wang commented Dec 18, 2020

ghost commented Jan 3, 2021

anrudraw commented Jan 5, 2021

erich-wang commented Jan 6, 2021 • edited by ruowan Loading

anrudraw commented Jan 12, 2021

erich-wang commented Jan 18, 2021

openapi-pipeline-app bot commented Dec 2, 2020 •

edited

Loading

openapi-pipeline-app bot commented Dec 2, 2020 •

edited

Loading

erich-wang commented Jan 6, 2021 •

edited by ruowan

Loading