[MarketplaceOrdering] [S360] Add missing Operations example #20936

meirloichter · 2022-09-29T13:42:12Z

ARM API Information (Control Plane)

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
- 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.
By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

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

Applicability: ⚠️

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:

Check this box if any of the following apply 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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

openapi-workflow-bot · 2022-09-29T13:42:14Z

Hi, @meirloichter 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. vscswagger@microsoft.com

openapi-pipeline-app · 2022-09-29T13:42:15Z

Swagger Validation Report

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

There are no breaking changes.

compared swaggers (via Oad v0.9.7)]	new version	base version
Agreements.json	2021-01-01(1e829f7)	2021-01-01(main)

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

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

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v1.13.0)	new version	base version
package-2021-01-01	package-2021-01-01(1e829f7)	package-2021-01-01(main)

The following errors/warnings exist before current PR submission:

Rule	Message
`❌` R4015 - NestedResourcesMustHaveListOperation	The nested resource 'AgreementTerms' does not have list operation, please add it. Location: Microsoft.MarketplaceOrdering/stable/2021-01-01/Agreements.json#L389
`❌` R4018 - OperationsApiResponseSchema	The response schema of operations API '/providers/Microsoft.MarketplaceOrdering/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.MarketplaceOrdering/stable/2021-01-01/Agreements.json#L134
`❌` R4037 - MissingTypeObject	The schema 'AgreementTerms' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.MarketplaceOrdering/stable/2021-01-01/Agreements.json#L389
`❌` R4037 - MissingTypeObject	The schema 'AgreementProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.MarketplaceOrdering/stable/2021-01-01/Agreements.json#L409
`❌` R4037 - MissingTypeObject	The schema 'error' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.MarketplaceOrdering/stable/2021-01-01/Agreements.json#L455
`❌` R4037 - MissingTypeObject	The schema 'display' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.MarketplaceOrdering/stable/2021-01-01/Agreements.json#L480
`❌` R4037 - MissingTypeObject	The schema 'OperationListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.MarketplaceOrdering/stable/2021-01-01/Agreements.json#L503
`❌` R4037 - MissingTypeObject	The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.MarketplaceOrdering/stable/2021-01-01/Agreements.json#L523
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: accepted Location: Microsoft.MarketplaceOrdering/stable/2021-01-01/Agreements.json#L444
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: SetMarketplaceTerms Location: Microsoft.MarketplaceOrdering/stable/2021-01-01/Agreements.json#L174
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: SetMarketplaceTerms Location: Microsoft.MarketplaceOrdering/stable/2021-01-01/Agreements.json#L216
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: SetMarketplaceTerms Location: Microsoft.MarketplaceOrdering/stable/2021-01-01/Agreements.json#L258

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

Validation passes for Avocado.

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

API Test is not triggered due to precheck failure. Check pipeline log for details.

️⚠️~[Staging] TrafficValidation: 0 Warnings warning [Detail]

API Test is not triggered due to precheck failure. Check pipeline log for details.

️️✔️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: 0 Warnings warning [Detail]

The following tags are being changed in this PR

"https://github.com/Azure/azure-rest-api-specs/blob/1e829f7c80a066184f17edcd87ce92d53c3001bd/specification/marketplaceordering/resource-manager/readme.md#tag-package-2021-01-01">marketplaceordering/resource-manager/readme.md#package-2021-01-01

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ UnkownSecurityScheme	"readme":"marketplaceordering/resource-manager/readme.md", "tag":"package-2021-01-01", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous"

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

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

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

openapi-pipeline-app · 2022-09-29T13:42:15Z

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account.

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️❌ azure-sdk-for-net failed [Detail]

❌Failed [Logs]Release - Generate from a3ba4df. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-6.0
command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/mnt/vss/_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
cmderr	[Autorest] No usable version of the libssl was found
cmderr	[Autorest] FATAL: csharp/simplifier - FAILED
cmderr	[Autorest] FATAL: Error: [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
cmderr	[Autorest] Process() cancelled due to exception : [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest
warn	Skip package processing as generation is failed

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

⚠️Warning [Logs]Release - Generate from a3ba4df. 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] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh]
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.15.0 -> 8.19.2
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.19.2>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@8.19.2` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-marketplaceordering [View full logs] [Release SDK Changes]
- azure_mgmt_marketplaceordering-1.0.0b1-py3-none-any.whl
- azure-mgmt-marketplaceordering-1.0.0b1.zip
```
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Model OperationDisplay has a new parameter description
```

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

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

command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️sdk/resourcemanager/marketplaceordering/armmarketplaceordering [View full logs] [Release SDK Changes]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

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

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

command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
cmderr	[automation_generate.sh] [ERROR] Cannot generate changelog because the codes of local and npm may be the same.

️✔️@azure/arm-marketplaceordering [View full logs] [Release SDK Changes]
- azure-arm-marketplaceordering-3.1.1.tgz
```
info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
```

️⚠️ azure-resource-manager-schemas warning [Detail]

⚠️Warning [Logs]Release - Generate from a3ba4df. Schema Automation 14.0.0

command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
cmderr	[initScript.sh] WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
cmderr	[initScript.sh] npm WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
cmderr	[initScript.sh] npm WARN old lockfile
warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
warn	No file changes detected after generation

️✔️marketplaceordering [View full logs]

️️✔️ azure-powershell succeeded [Detail] [Expand]

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

command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json

️✔️Az.MarketplaceOrderingAgreements [View full logs] [Release SDK Changes]
- Az.MarketplaceOrderingAgreements.0.1.0.nupkg

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

openapi-pipeline-app · 2022-09-29T13:42:16Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/marketplaceordering/armmarketplaceordering	https://apiview.dev/Assemblies/Review/ccb284c103754fe0a71155a14d4749f1
Python	track2_azure-mgmt-marketplaceordering	https://apiview.dev/Assemblies/Review/947faebe6a96417ba110eb7f277acc11
JavaScript	@azure/arm-marketplaceordering	There is no API change compared with the previous version

meirloichter · 2022-09-29T14:40:39Z

/azp run

azure-pipelines · 2022-09-29T14:40:45Z

Commenter does not have sufficient privileges for PR 20936 in repo Azure/azure-rest-api-specs

\

Adding example for MarketplaceOrdering

5c94fac

openapi-assignment-bot bot assigned changlong-liu Sep 29, 2022

azure-sdk mentioned this pull request Sep 29, 2022

[AutoPR sdk/resourcemanager/marketplaceordering/armmarketplaceordering] [MarketplaceOrdering] [S360] Add missing Operations example azure-sdk/azure-sdk-for-go#3147

Closed

AzureRestAPISpecReview added the resource-manager label Sep 29, 2022

meirloichter added 2 commits September 30, 2022 10:48

fix operations list example name

60e4a75

\

fix typo

1e829f7

raych1 approved these changes Oct 3, 2022

View reviewed changes

raych1 added the FixSwaggerExample PR includes swagger example fix label Oct 3, 2022

raych1 merged commit a3ba4df into Azure:main Oct 3, 2022

meirloichter deleted the meirloichter/UpdateMarketplaceOrderingAgreementDoc branch October 3, 2022 08:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[MarketplaceOrdering] [S360] Add missing Operations example #20936

[MarketplaceOrdering] [S360] Add missing Operations example #20936

meirloichter commented Sep 29, 2022

openapi-workflow-bot bot commented Sep 29, 2022

openapi-pipeline-app bot commented Sep 29, 2022 •

edited

Loading

openapi-pipeline-app bot commented Sep 29, 2022 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented Sep 29, 2022 •

edited

Loading

meirloichter commented Sep 29, 2022

azure-pipelines bot commented Sep 29, 2022

[MarketplaceOrdering] [S360] Add missing Operations example #20936

[MarketplaceOrdering] [S360] Add missing Operations example #20936

Conversation

meirloichter commented Sep 29, 2022

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Sep 29, 2022

openapi-pipeline-app bot commented Sep 29, 2022 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Sep 29, 2022 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Sep 29, 2022 • edited Loading

Generated ApiView

meirloichter commented Sep 29, 2022

azure-pipelines bot commented Sep 29, 2022

openapi-pipeline-app bot commented Sep 29, 2022 •

edited

Loading

openapi-pipeline-app bot commented Sep 29, 2022 •

edited

Loading

openapi-pipeline-app bot commented Sep 29, 2022 •

edited

Loading