Updating marketplace oredring with new version of Swagger by alkigel · Pull Request #12469 · Azure/azure-rest-api-specs

alkigel · 2021-01-17T10:21:26Z

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.

…n to 2021-01-01

… parameter

openapi-workflow-bot · 2021-01-17T10:21:29Z

Hi, @alkigel 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. vsswagger@microsoft.com

openapi-pipeline-app · 2021-01-17T10:21:30Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

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

Validation passes for LintDiff.

Linted configuring files (Based on source branch, openapi-validator v1.7.0 , classic-openapi-validator v1.1.5 )
- marketplaceordering/resource-manager/readme.md tag:package-2021-01-01
Linted configuring files (Based on target branch, openapi-validator v1.7.0 , classic-openapi-validator v1.1.5 )
- marketplaceordering/resource-manager/readme.md tag:default

️️✔️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.

Compared Swaggers (Based on Oad v0.8.6)
- original: stable/2015-06-01/Agreements.json <---> new: stable/2021-01-01/Agreements.json

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

There is no credential detected.

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

openapi-pipeline-app · 2021-01-17T10:21:31Z

Swagger Generation Artifacts

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

️✔️Succeeded [Logs]Release - Generate from 4be1743. 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/marketplaceordering/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.MarketplaceOrdering [View full logs] [Release SDK Changes]
- Microsoft.Azure.Management.MarketplaceOrdering.1.0.1.nupkg
- Microsoft.Azure.Management.MarketplaceOrdering.1.0.1.snupkg

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

️✔️Succeeded [Logs]Release - Generate from 4be1743. 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.6351 --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/marketplaceordering/resource-manager/readme.md

️✔️marketplaceordering [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] npm WARN template-schema-validation-tools@1.0.0 No repository field.
cmderr	[resource-manager] npm 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-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 4be1743. 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

️✔️marketplaceordering/mgmt/2015-06-01/marketplaceordering [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```

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

⚠️Warning [Logs]Release - Generate from 4be1743. 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
warn	File azure-sdk-for-python_tmp/generateOutput.json not found to read
warn	No file changes detected after generation
warn	No package detected after generation

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

️✔️Succeeded [Logs]Release - Generate from 4be1743. 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/marketplaceordering/resource-manager/readme.md

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

azure-arm-marketplaceordering-2.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/marketplaceOrderingAgreements.js → ./dist/arm-marketplaceordering.js...
cmderr	[npmPack] created ./dist/arm-marketplaceordering.js in 185ms

️️✔️[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 · 2021-01-17T10:25:12Z

Hi @alkigel, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

Task	How to fix	Priority	Support (Microsoft alias)
Avocado	Fix-Avocado	High	ruowan
Semantic validation	Fix-SemanticValidation-Error	High	raychen, jianyxi
Model validation	Fix-ModelValidation-Error	High	raychen,jianyxi
LintDiff	Fix-LintDiff	high	jianyxi, ruoxuan

If you need further help, please feedback via swagger feedback."

njuCZ · 2021-01-18T02:46:33Z

@alkigel please fix the lintDiff and prettiercheck CI

alkigel · 2021-01-20T10:50:52Z

@njuCZ
I am still unclear about the changes I’m required to add to my PR.
My goal was to add a single parameter to an existing API, for this I duplicated an existing swagger file (which has already been approved in the past and is currently in master), and added only a single parameter to the new version, as visible in my commit history.
As you can see, both swaggers (the one in master – 2015-06-01, and the one I’m adding – 2021-01-01) are identical, except the version number, and a single parameter.

So I don’t see why I need to add systemData parameters, as per LintDiff’s error, if the API definition have been approved in the past for the old swagger.

I’d be happy to hear your thoughts on the matter, and on how we can resolve this PR without further changing the API

njuCZ · 2021-01-21T02:57:20Z

@alkigel you could refer to this rule: https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/openapi-authoring-automated-guidelines.md#R4009

alkigel · 2021-01-25T14:51:59Z

Hi @njuCZ
It seems all issues have been resolved, but the PR has not been approved yet,
Is there anything else I need to do so this PR is approved?

njuCZ · 2021-01-26T02:09:24Z

/azp run

azure-pipelines · 2021-01-26T02:09:38Z

Azure Pipelines successfully started running 2 pipeline(s).

alkigel added 4 commits January 17, 2021 12:15

Duplicating marketplaceordering swagger folder from 2015-06-01 versio…

6c39489

…n to 2021-01-01

Updating swagger for marketplaceordering, 2021-01-01 version with new…

74516d6

… parameter

updating example files for marketplaceordering version 2021-01-01

189d2df

updating readme.md of marketplaceordering with new version 2021-01-01

35f8ab6

alkigel requested a review from lirenhe as a code owner January 17, 2021 10:21

openapi-assignment-bot bot assigned njuCZ Jan 17, 2021

openapi-sdkautomation bot mentioned this pull request Jan 17, 2021

[AutoPR @azure/arm-marketplaceordering] Updating marketplace oredring with new version of Swagger AzureSDKAutomation/azure-sdk-for-js#3246

Closed

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Jan 17, 2021

Fixing style in Agreements.json

110020a

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Jan 18, 2021

Adding systemData property to responses in Agreements.json

05c6812

openapi-pipeline-app bot removed the CI-FixRequiredOnFailure label Jan 21, 2021

njuCZ added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jan 22, 2021

pilor self-requested a review January 25, 2021 19:31

pilor added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jan 25, 2021

njuCZ approved these changes Jan 26, 2021

View reviewed changes

njuCZ merged commit 4be1743 into Azure:master Jan 26, 2021

alkigel mentioned this pull request Mar 24, 2021

MarketplaceOrdering SDK update Azure/azure-sdk-for-net#19451

Closed

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updating marketplace oredring with new version of Swagger#12469

Updating marketplace oredring with new version of Swagger#12469
njuCZ merged 6 commits intoAzure:masterfrom
alkigel:master

alkigel commented Jan 17, 2021

Uh oh!

openapi-workflow-bot bot commented Jan 17, 2021

Uh oh!

openapi-pipeline-app bot commented Jan 17, 2021 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Jan 17, 2021 •

edited

Loading

Uh oh!

openapi-workflow-bot bot commented Jan 17, 2021

Uh oh!

njuCZ commented Jan 18, 2021

Uh oh!

alkigel commented Jan 20, 2021

Uh oh!

njuCZ commented Jan 21, 2021

Uh oh!

alkigel commented Jan 25, 2021

Uh oh!

njuCZ commented Jan 26, 2021

Uh oh!

azure-pipelines bot commented Jan 26, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

alkigel commented Jan 17, 2021

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

Uh oh!

openapi-workflow-bot bot commented Jan 17, 2021

Uh oh!

openapi-pipeline-app bot commented Jan 17, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Validation Report

Uh oh!

openapi-pipeline-app bot commented Jan 17, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Generation Artifacts

Uh oh!

openapi-workflow-bot bot commented Jan 17, 2021

Uh oh!

njuCZ commented Jan 18, 2021

Uh oh!

alkigel commented Jan 20, 2021

Uh oh!

njuCZ commented Jan 21, 2021

Uh oh!

alkigel commented Jan 25, 2021

Uh oh!

njuCZ commented Jan 26, 2021

Uh oh!

azure-pipelines bot commented Jan 26, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

openapi-pipeline-app bot commented Jan 17, 2021 •

edited

Loading

openapi-pipeline-app bot commented Jan 17, 2021 •

edited

Loading