Marketplace - fix swagger #19663

saviesacov · 2022-07-04T07:50:54Z

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:

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.
If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the 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 refresh required 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

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

openapi-workflow-bot · 2022-07-04T07:50:57Z

Hi, @saviesacov 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]

openapi-pipeline-app · 2022-07-04T07:50:59Z

Swagger Validation Report

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

compared swaggers (via Oad v0.9.6)]	new version	base version
Marketplace.json	2022-03-01(4b490ae)	2022-03-01(main)

Rule	Message
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'allItemsApproved' renamed or removed? New: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L1910:7 Old: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L1910:7
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'allItemsApprovedModifiedAt' renamed or removed? New: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L1910:7 Old: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L1910:7
`❌` 1040 - AddedReadOnlyPropertyInResponse	The new version has a new read-only property 'approveAllItems' in response that was not found in the old version. New: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L1910:7 Old: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L1910:7
`❌` 1040 - AddedReadOnlyPropertyInResponse	The new version has a new read-only property 'approveAllItemsModifiedAt' in response that was not found in the old version. New: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L1910:7 Old: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L1910:7
`❌` 1041 - AddedPropertyInResponse	The new version has a new property 'id' in response that was not found in the old version. New: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L3232:7 Old: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L3232:7
`❌` 1045 - AddedOptionalProperty	The new version has a new optional property 'approveAllItems' that was not found in the old version. New: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L1910:7 Old: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L1910:7
`❌` 1045 - AddedOptionalProperty	The new version has a new optional property 'approveAllItemsModifiedAt' that was not found in the old version. New: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L1910:7 Old: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L1910:7

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

There are no breaking changes.

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

There is no credential detected.

️⚠️LintDiff: 1 Warnings warning [Detail]

compared tags (via openapi-validator v1.13.0)	new version	base version
package-2022-03	package-2022-03(4b490ae)	package-2022-03(main)

The following errors/warnings are introduced by current PR:

Rule	Message
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: approveAllItems Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L1928

The following errors/warnings exist before current PR submission:

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

Rule	Message
⚠️ R1003 - ListInOperationName	Since operation 'PrivateStoreQueryOffers' response has model definition 'array', it should be of the form 'list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L210
⚠️ R1003 - ListInOperationName	Since operation 'PrivateStoreQueryUserOffers' response has model definition 'array', it should be of the form 'list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L248
⚠️ R1003 - ListInOperationName	Since operation 'PrivateStoreBillingAccounts' response has model definition 'array', it should be of the form 'list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L293
⚠️ R1003 - ListInOperationName	Since operation 'PrivateStoreCollectionTransferOffers' response has model definition 'array', it should be of the form 'list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L568
⚠️ R1003 - ListInOperationName	Since operation 'PrivateStoreBulkCollectionsAction' response has model definition 'array', it should be of the form 'list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L661
⚠️ R1003 - ListInOperationName	Since operation 'PrivateStoreGetApprovalRequestsList' response has model definition 'array', it should be of the form 'list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L1049
⚠️ R1003 - ListInOperationName	Since operation 'PrivateStoreAdminRequestApprovalsList' response has model definition 'array', it should be of the form 'list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L1217
⚠️ R1005 - GetInOperationName	'GET' operation 'PrivateStore_AdminRequestApprovalsList' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L1217
⚠️ R1006 - PutInOperationName	'PUT' operation 'PrivateStore_UpdateAdminRequestApproval' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L1292
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L2472
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L2996
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L3275
⚠️ R2017 - PutRequestResponseScheme	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: 'PrivateStore_CreateOrUpdate' Request Model: 'PrivateStore' Response Model: '' Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L95
⚠️ R2029 - PageableOperation	Based on the response model schema, operation 'PrivateStoreCollection_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L372
⚠️ R2029 - PageableOperation	Based on the response model schema, operation 'PrivateStore_GetApprovalRequestsList' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L1045
⚠️ R2029 - PageableOperation	Based on the response model schema, operation 'PrivateStore_AdminRequestApprovalsList' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L1213
⚠️ R2029 - PageableOperation	Based on the response model schema, operation 'Operations_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L1621
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L32
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L68
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L99
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L134
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L172
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L210
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L248
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L293
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L331
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L616
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L661
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L1049
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L1087

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

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

marketplace/resource-manager/readme.md#package-2022-03

The following errors/warnings are introduced by current PR:

|:speech_balloon: |"readme":"marketplace/resource-manager/readme.md",
"tag":"package-2022-03",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0 -> 1.11.0)"|
|:speech_balloon: |"readme":"marketplace/resource-manager/readme.md",
"tag":"package-2022-03",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0->1.11.0)"|
|:speech_balloon: |"readme":"marketplace/resource-manager/readme.md",
"tag":"package-2022-03",
"details":"> Installing AutoRest extension '@autorest/modelerfour' (4.21.4 -> 4.21.4)"|
|:speech_balloon: |"readme":"marketplace/resource-manager/readme.md",
"tag":"package-2022-03",
"details":"> Installed AutoRest extension '@autorest/modelerfour' (4.21.4->4.21.4)"|
|:speech_balloon: |"readme":"marketplace/resource-manager/readme.md",
"tag":"package-2022-03",
"details":"Autorest completed in 11.6s. 0 files generated."|

The following errors/warnings exist before current PR submission:

|:speech_balloon: |"readme":"marketplace/resource-manager/readme.md",
"tag":"package-2022-03",
"details":"AutoRest core version selected from configuration: ^3.2.0."|

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

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

openapi-pipeline-app · 2022-07-04T07:51:00Z

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account.

️❌SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

❌azure-sdk-for-go - armmarketplace - Approved - 2.0.0

+	Field `Payload` of struct `PrivateStoreClientCreateApprovalRequestOptions` has been removed
+	Field `Payload` of struct `PrivateStoreClientCreateOrUpdateOptions` has been removed
+	Field `Payload` of struct `PrivateStoreClientUpdateAdminRequestApprovalOptions` has been removed
+	Field `Payload` of struct `PrivateStoreCollectionClientCreateOrUpdateOptions` has been removed
+	Field `Payload` of struct `PrivateStoreCollectionOfferClientCreateOrUpdateOptions` has been removed
+	Function `*PrivateStoreClient.CreateApprovalRequest` parameter(s) have been changed from `(context.Context, string, string, *PrivateStoreClientCreateApprovalRequestOptions)` to `(context.Context, string, string, RequestApprovalResource, *PrivateStoreClientCreateApprovalRequestOptions)`
+	Function `*PrivateStoreClient.CreateOrUpdate` parameter(s) have been changed from `(context.Context, string, *PrivateStoreClientCreateOrUpdateOptions)` to `(context.Context, string, PrivateStore, *PrivateStoreClientCreateOrUpdateOptions)`
+	Function `*PrivateStoreClient.UpdateAdminRequestApproval` parameter(s) have been changed from `(context.Context, string, string, *PrivateStoreClientUpdateAdminRequestApprovalOptions)` to `(context.Context, string, string, AdminRequestApprovalsResource, *PrivateStoreClientUpdateAdminRequestApprovalOptions)`
+	Function `*PrivateStoreCollectionClient.CreateOrUpdate` parameter(s) have been changed from `(context.Context, string, string, *PrivateStoreCollectionClientCreateOrUpdateOptions)` to `(context.Context, string, string, Collection, *PrivateStoreCollectionClientCreateOrUpdateOptions)`
+	Function `*PrivateStoreCollectionOfferClient.CreateOrUpdate` parameter(s) have been changed from `(context.Context, string, string, string, *PrivateStoreCollectionOfferClientCreateOrUpdateOptions)` to `(context.Context, string, string, string, Offer, *PrivateStoreCollectionOfferClientCreateOrUpdateOptions)`

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

❌Failed [Logs]Release - Generate from 8e4e305. 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 [email protected]/[email protected] --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/marketplace/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-go succeeded [Detail] [Expand]

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

️✔️armmarketplace [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Function `*PrivateStoreClient.UpdateAdminRequestApproval` parameter(s) have been changed from `(context.Context, string, string, *PrivateStoreClientUpdateAdminRequestApprovalOptions)` to `(context.Context, string, string, AdminRequestApprovalsResource, *PrivateStoreClientUpdateAdminRequestApprovalOptions)`
info	[Changelog] - Function `*PrivateStoreCollectionClient.CreateOrUpdate` parameter(s) have been changed from `(context.Context, string, string, *PrivateStoreCollectionClientCreateOrUpdateOptions)` to `(context.Context, string, string, Collection, *PrivateStoreCollectionClientCreateOrUpdateOptions)`
info	[Changelog] - Function `*PrivateStoreClient.CreateOrUpdate` parameter(s) have been changed from `(context.Context, string, *PrivateStoreClientCreateOrUpdateOptions)` to `(context.Context, string, PrivateStore, *PrivateStoreClientCreateOrUpdateOptions)`
info	[Changelog] - Function `*PrivateStoreClient.CreateApprovalRequest` parameter(s) have been changed from `(context.Context, string, string, *PrivateStoreClientCreateApprovalRequestOptions)` to `(context.Context, string, string, RequestApprovalResource, *PrivateStoreClientCreateApprovalRequestOptions)`
info	[Changelog] - Function `*PrivateStoreCollectionOfferClient.CreateOrUpdate` parameter(s) have been changed from `(context.Context, string, string, string, *PrivateStoreCollectionOfferClientCreateOrUpdateOptions)` to `(context.Context, string, string, string, Offer, *PrivateStoreCollectionOfferClientCreateOrUpdateOptions)`
info	[Changelog] - Field `Payload` of struct `PrivateStoreCollectionOfferClientCreateOrUpdateOptions` has been removed
info	[Changelog] - Field `Payload` of struct `PrivateStoreCollectionClientCreateOrUpdateOptions` has been removed
info	[Changelog] - Field `Payload` of struct `PrivateStoreClientUpdateAdminRequestApprovalOptions` has been removed
info	[Changelog] - Field `Payload` of struct `PrivateStoreClientCreateApprovalRequestOptions` has been removed
info	[Changelog] - Field `Payload` of struct `PrivateStoreClientCreateOrUpdateOptions` has been removed
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New function `*PrivateStoreClient.AnyExistingOffersInTheCollections(context.Context, string, *PrivateStoreClientAnyExistingOffersInTheCollectionsOptions) (PrivateStoreClientAnyExistingOffersInTheCollectionsResponse, error)`
info	[Changelog] - New function `*PrivateStoreCollectionClient.DisableApproveAllItems(context.Context, string, string, *PrivateStoreCollectionClientDisableApproveAllItemsOptions) (PrivateStoreCollectionClientDisableApproveAllItemsResponse, error)`
info	[Changelog] - New function `*PrivateStoreCollectionOfferClient.UpsertOfferWithMultiContext(context.Context, string, string, string, *PrivateStoreCollectionOfferClientUpsertOfferWithMultiContextOptions) (PrivateStoreCollectionOfferClientUpsertOfferWithMultiContextResponse, error)`
info	[Changelog] - New function `*PrivateStoreClient.QueryUserOffers(context.Context, string, *PrivateStoreClientQueryUserOffersOptions) (PrivateStoreClientQueryUserOffersResponse, error)`
info	[Changelog] - New function `*PrivateStoreCollectionClient.ApproveAllItems(context.Context, string, string, *PrivateStoreCollectionClientApproveAllItemsOptions) (PrivateStoreCollectionClientApproveAllItemsResponse, error)`
info	[Changelog] - New struct `AnyExistingOffersInTheCollectionsResponse`
info	[Changelog] - New struct `ContextAndPlansDetails`
info	[Changelog] - New struct `MultiContextAndPlansPayload`
info	[Changelog] - New struct `MultiContextAndPlansProperties`
info	[Changelog] - New struct `PrivateStoreClientAnyExistingOffersInTheCollectionsOptions`
info	[Changelog] - New struct `PrivateStoreClientAnyExistingOffersInTheCollectionsResponse`
info	[Changelog] - New struct `PrivateStoreClientQueryUserOffersOptions`
info	[Changelog] - New struct `PrivateStoreClientQueryUserOffersResponse`
info	[Changelog] - New struct `PrivateStoreCollectionClientApproveAllItemsOptions`
info	[Changelog] - New struct `PrivateStoreCollectionClientApproveAllItemsResponse`
info	[Changelog] - New struct `PrivateStoreCollectionClientDisableApproveAllItemsOptions`
info	[Changelog] - New struct `PrivateStoreCollectionClientDisableApproveAllItemsResponse`
info	[Changelog] - New struct `PrivateStoreCollectionOfferClientUpsertOfferWithMultiContextOptions`
info	[Changelog] - New struct `PrivateStoreCollectionOfferClientUpsertOfferWithMultiContextResponse`
info	[Changelog] - New struct `QueryUserOffersDetails`
info	[Changelog] - New struct `QueryUserOffersProperties`
info	[Changelog] - New field `ApproveAllItems` in struct `CollectionProperties`
info	[Changelog] - New field `ApproveAllItemsModifiedAt` in struct `CollectionProperties`
info	[Changelog] - New field `ID` in struct `SingleOperation`
info	[Changelog] - New field `Icon` in struct `AdminRequestApprovalProperties`
info	[Changelog] - New field `SubscriptionIDs` in struct `QueryApprovedPlans`
info	[Changelog]
info	[Changelog] Total 10 breaking change(s), 41 additive change(s).

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

⚠️Warning [Logs]Release - Generate from 8e4e305. 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]  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

️✔️marketplace [View full logs]

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

️✔️Succeeded [Logs]Release - Generate from 8e4e305. 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.MarketplaceRpService [View full logs] [Release SDK Changes]
- Az.MarketplaceRpService.0.1.0.nupkg

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

openapi-workflow-bot · 2022-07-04T07:53:49Z

Hi @saviesacov, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

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

openapi-workflow-bot · 2022-07-04T07:54:14Z

Hi @saviesacov, 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 want to know the production traffic statistic, please see ARM Traffic statistic.
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.
Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

openapi-workflow-bot · 2022-07-04T07:54:14Z

NewApiVersionRequired reason:

A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

saviesacov · 2022-07-13T12:48:25Z

Hello @honghr ,
Can you please review what is missing for merge?
Thanks,
Savi

honghr · 2022-07-13T16:01:05Z

Hello @honghr , Can you please review what is missing for merge? Thanks, Savi

Hi, You also need Go SDK Owner to approve the breaking change. I will contact him.

ArcturusZhang

It is great we fix the property names to make them align with the actual service response.
But it is unnecessary to introduce SDK breaking changes because of this.
We could use x-ms-client-name to keep its original names in the SDKs so that the SDKs will break because of this change

...cation/marketplace/resource-manager/Microsoft.Marketplace/stable/2022-03-01/Marketplace.json

ArcturusZhang · 2022-07-14T05:38:54Z

...cation/marketplace/resource-manager/Microsoft.Marketplace/stable/2022-03-01/Marketplace.json

+        "id": {
+          "description": "Operation ID",
+          "type": "string"
+        },


We are adding this new property, but I did not see any examples are updated accordingly?
Could you please add at least one of the example to show what is the actual value of this "id'?

ArcturusZhang

It would be nice if we have an example using the newly added "id" property. But in general LGTM

saviesacov added 2 commits July 3, 2022 17:58

SingleOperation - add id prop

30b0f63

fix approveAllItems & approveAllItemsModifiedAt

b13d0fd

openapi-assignment-bot bot assigned honghr Jul 4, 2022

openapi-workflow-bot bot added the FixS360 label Jul 4, 2022

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Jul 4, 2022

openapi-pipeline-app bot added BreakingChangeReviewRequired labels Jul 4, 2022

azure-sdk mentioned this pull request Jul 4, 2022

[AutoPR armmarketplace] Marketplace - fix swagger azure-sdk/azure-sdk-for-go#1628

Closed

openapi-pipeline-app bot added the CI-BreakingChange-Go label Jul 4, 2022

fix examples

4b490ae

openapi-pipeline-app bot removed the CI-FixRequiredOnFailure label Jul 4, 2022

azure-sdk mentioned this pull request Jul 4, 2022

[AutoPR Az.MarketplaceRpService] Marketplace - fix swagger azure-sdk/azure-powershell#1285

Closed

JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jul 11, 2022

ArcturusZhang requested changes Jul 14, 2022

View reviewed changes

ArcturusZhang approved these changes Jul 14, 2022

View reviewed changes

ArcturusZhang added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Jul 14, 2022

honghr merged commit 8e4e305 into Azure:main Jul 14, 2022

This was referenced Jul 14, 2022

[ReleasePR armmarketplace] Marketplace - fix swagger Azure/azure-sdk-for-go#18337

Closed

[ReleasePR Az.MarketplaceRpService] Marketplace version 2023-01-01 Azure/azure-powershell#18426

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Marketplace - fix swagger #19663

Marketplace - fix swagger #19663

saviesacov commented Jul 4, 2022 •

edited

Loading

openapi-workflow-bot bot commented Jul 4, 2022

openapi-pipeline-app bot commented Jul 4, 2022 •

edited

Loading

openapi-pipeline-app bot commented Jul 4, 2022 •

edited

Loading

Breaking Changes Tracking

openapi-workflow-bot bot commented Jul 4, 2022

openapi-workflow-bot bot commented Jul 4, 2022

openapi-workflow-bot bot commented Jul 4, 2022

saviesacov commented Jul 13, 2022

honghr commented Jul 13, 2022

ArcturusZhang left a comment

ArcturusZhang Jul 14, 2022

ArcturusZhang left a comment

Marketplace - fix swagger #19663

Marketplace - fix swagger #19663

Conversation

saviesacov commented Jul 4, 2022 • edited Loading

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Jul 4, 2022

openapi-pipeline-app bot commented Jul 4, 2022 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Jul 4, 2022 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-workflow-bot bot commented Jul 4, 2022

openapi-workflow-bot bot commented Jul 4, 2022

openapi-workflow-bot bot commented Jul 4, 2022

saviesacov commented Jul 13, 2022

honghr commented Jul 13, 2022

ArcturusZhang left a comment

Choose a reason for hiding this comment

ArcturusZhang Jul 14, 2022

Choose a reason for hiding this comment

ArcturusZhang left a comment

Choose a reason for hiding this comment

saviesacov commented Jul 4, 2022 •

edited

Loading

openapi-pipeline-app bot commented Jul 4, 2022 •

edited

Loading

openapi-pipeline-app bot commented Jul 4, 2022 •

edited

Loading