Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New swagger version - Add new rules API to privatestore #20577

Merged
merged 4 commits into from
Oct 12, 2022

Conversation

tomercigler
Copy link
Contributor

@tomercigler tomercigler commented Sep 4, 2022

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:

  1. 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
  2. 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.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. 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):

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
Copy link

Hi, @tomercigler 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
    Copy link

    openapi-pipeline-app bot commented Sep 4, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️❌Breaking Change(Cross-Version): 11 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.0)] new version base version
    Marketplace.json 2022-09-01(6436351) 2022-03-01(main)

    The following breaking changes are detected by comparison with the latest stable version:

    Rule Message
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'modelAsString' than the previous one.
    New: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L1902:9
    Old: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L1771:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'modelAsString' than the previous one.
    New: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L3571:9
    Old: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L3344:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'modelAsString' than the previous one.
    New: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L3584:9
    Old: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L3357:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'modelAsString' than the previous one.
    New: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L2296:9
    Old: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L2093:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'modelAsString' than the previous one.
    New: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L574:13
    Old: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L529:13
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'modelAsString' than the previous one.
    New: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L1087:13
    Old: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L956:13
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'modelAsString' than the previous one.
    New: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L2611:9
    Old: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L2408:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'modelAsString' than the previous one.
    New: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L2372:9
    Old: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L2169:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'modelAsString' than the previous one.
    New: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L3403:9
    Old: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L3176:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'modelAsString' than the previous one.
    New: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L3421:5
    Old: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L3194:5
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'modelAsString' than the previous one.
    New: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L3595:5
    Old: Microsoft.Marketplace/stable/2022-03-01/Marketplace.json#L3368:5
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 11 Warnings warning [Detail]
    compared tags (via openapi-validator v1.13.0) new version base version
    package-2022-09 package-2022-09(6436351) default(main)

    [must fix]The following errors/warnings are introduced by current PR:

    Rule Message Related RPC [For API reviewers]
    ⚠️ R1003 - ListInOperationName Since operation 'QueryUserRules' 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-09-01/Marketplace.json#L293
    ⚠️ R1003 - ListInOperationName Since operation 'QueryRules' 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-09-01/Marketplace.json#L922
    ⚠️ R2066 - PostOperationIdContainsUrlVerb OperationId should contain the verb: 'setrules' in:'SetCollectionRules'. Consider updating the operationId
    Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L877
    ⚠️ R4000 - ParameterDescriptionRequired 'payload' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation.
    Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L299
    ⚠️ R4000 - ParameterDescriptionRequired 'payload' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation.
    Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L886
    ⚠️ R4021 - DescriptionAndTitleMissing 'RuleListResponse' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L2100
    ⚠️ R4021 - DescriptionAndTitleMissing 'value' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L2103
    ⚠️ R4021 - DescriptionAndTitleMissing 'SetRulesRequest' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L2119
    ⚠️ R4021 - DescriptionAndTitleMissing 'value' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L2122
    ⚠️ R4021 - DescriptionAndTitleMissing 'Rule' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L2137
    ⚠️ R4021 - DescriptionAndTitleMissing 'value' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L2152


    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-09-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-09-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-09-01/Marketplace.json#L338
    ⚠️ 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-09-01/Marketplace.json#L613
    ⚠️ 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-09-01/Marketplace.json#L706
    ⚠️ 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-09-01/Marketplace.json#L1180
    ⚠️ 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-09-01/Marketplace.json#L1348
    ⚠️ 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-09-01/Marketplace.json#L1348
    ⚠️ 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-09-01/Marketplace.json#L1423
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L2675
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L3223
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L3502
    ⚠️ 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-09-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-09-01/Marketplace.json#L417
    ⚠️ 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-09-01/Marketplace.json#L1176
    ⚠️ 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-09-01/Marketplace.json#L1344
    ⚠️ 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-09-01/Marketplace.json#L1752
    ⚠️ 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-09-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-09-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-09-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-09-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-09-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-09-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-09-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-09-01/Marketplace.json#L338
    ⚠️ 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-09-01/Marketplace.json#L376
    ⚠️ 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-09-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-09-01/Marketplace.json#L706
    ⚠️ 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-09-01/Marketplace.json#L1180
    ⚠️ 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-09-01/Marketplace.json#L1218
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️❌ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    API Readiness check failed. Please make sure your service is deployed. "code: InvalidResourceType,
    message: The resource type 'operations' could not be found in the namespace 'Microsoft.Marketplace' for api version '2022-09-01'. The supported api-versions are '2018-03-01-beta,
    2021-12-01,
    2022-03-01'."
    ️❌~[Staging] ServiceAPIReadinessTest: 0 Errors, 0 Warnings failed [Detail]

    Tag package-2022-09; Prod region: Not deployed; Canary region: Not deployed

    ️❌~[Staging] TrafficValidation: 0 Errors, 0 Warnings failed [Detail]

    Tag package-2022-09; Prod region: Not deployed; Canary region: Not deployed

    ️️✔️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: 1 Warnings warning [Detail]
    • The following tags are being changed in this PR
      • "https://github.com/Azure/azure-rest-api-specs/blob/643635180e008f3c05780f567adf8daadf562d6f/specification/marketplace/resource-manager/readme.md#tag-package-2022-09">marketplace/resource-manager/readme.md#package-2022-09
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ Modeler/MissingType "readme":"marketplace/resource-manager/readme.md",
    "tag":"package-2022-09",
    "details":"The schema 'planDetails-requestDate' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#/components/schemas/planDetails-requestDate"
    ️️✔️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
    Copy link

    openapi-pipeline-app bot commented Sep 4, 2022

    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 8d482b2. 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 8d482b2. 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/marketplace/armmarketplace [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New const `RuleTypeTermsAndCondition`
      info	[Changelog] - New const `RuleTypePrivateProducts`
      info	[Changelog] - New type alias `RuleType`
      info	[Changelog] - New function `PossibleRuleTypeValues() []RuleType`
      info	[Changelog] - New function `*RPServiceClient.QueryUserRules(context.Context, string, *RPServiceClientQueryUserRulesOptions) (RPServiceClientQueryUserRulesResponse, error)`
      info	[Changelog] - New function `*PrivateStoreCollectionOfferClient.UpsertOfferWithMultiContext(context.Context, string, string, string, *PrivateStoreCollectionOfferClientUpsertOfferWithMultiContextOptions) (PrivateStoreCollectionOfferClientUpsertOfferWithMultiContextResponse, error)`
      info	[Changelog] - New function `NewRPServiceClient(azcore.TokenCredential, *arm.ClientOptions) (*RPServiceClient, error)`
      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 `*RPServiceClient.QueryRules(context.Context, string, string, *RPServiceClientQueryRulesOptions) (RPServiceClientQueryRulesResponse, 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 function `*RPServiceClient.SetCollectionRules(context.Context, string, string, *RPServiceClientSetCollectionRulesOptions) (RPServiceClientSetCollectionRulesResponse, 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 struct `QueryUserRulesDetails`
      info	[Changelog] - New struct `QueryUserRulesProperties`
      info	[Changelog] - New struct `RPServiceClient`
      info	[Changelog] - New struct `RPServiceClientQueryRulesOptions`
      info	[Changelog] - New struct `RPServiceClientQueryRulesResponse`
      info	[Changelog] - New struct `RPServiceClientQueryUserRulesOptions`
      info	[Changelog] - New struct `RPServiceClientQueryUserRulesResponse`
      info	[Changelog] - New struct `RPServiceClientSetCollectionRulesOptions`
      info	[Changelog] - New struct `RPServiceClientSetCollectionRulesResponse`
      info	[Changelog] - New struct `Rule`
      info	[Changelog] - New struct `RuleListResponse`
      info	[Changelog] - New struct `SetRulesRequest`
      info	[Changelog] - New field `SubscriptionIDs` in struct `QueryApprovedPlans`
      info	[Changelog] - New field `Icon` in struct `AdminRequestApprovalProperties`
      info	[Changelog] - New field `AppliedRules` in struct `CollectionProperties`
      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]
      info	[Changelog] Total 0 breaking change(s), 73 additive change(s).
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 8d482b2. 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
    • ️✔️marketplace [View full logs]  [Release Schema Changes]
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8d482b2. 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]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Sep 4, 2022

    Swagger pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

    @openapi-workflow-bot
    Copy link

    Hi @tomercigler, 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.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @openapi-workflow-bot
    Copy link

    Hi, @tomercigler your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).

    @mentat9
    Copy link
    Member

    mentat9 commented Sep 8, 2022

        "x-ms-pageable": {
    

    This looks like a mistake, since there is no response payload. x-ms-pageable doesn't work on POST actions anyway, AFAIK.


    In reply to: 1241287893


    Refers to: specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2022-09-01/Marketplace.json:905 in a129502. [](commit_id = a12950206627190cad541e23c95bff7266f6ca26, deletion_comment = False)

    @mentat9
    Copy link
    Member

    mentat9 commented Sep 8, 2022

      "post": {
    

    Removing the GET method is a cross-version breaking change. You'll need to get this reviewed by the breaking change board. I'll add the BreakingChangReviewRequired label - instructions will be in PR comments.


    In reply to: 1241287930


    In reply to: 1241287930


    Refers to: specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2022-09-01/Marketplace.json:921 in 6436351. [](commit_id = 6436351, deletion_comment = False)

    @mentat9 mentat9 added ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review BreakingChangeReviewRequired labels Sep 8, 2022
    @openapi-workflow-bot
    Copy link

    Hi @tomercigler, 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
    Copy link

    Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 8, 2022
    @tomercigler
    Copy link
    Contributor Author

    tomercigler commented Sep 11, 2022

    Hi @mentat9 , thank you very much for your great review.
    About the Breaking changes - this is a new API (you can see that i added that in that PR) so it can be breaking change.
    About the second comment - fix, thanks again!

    BTW we added more 1 API change, can you check that please?

    @tomercigler
    Copy link
    Contributor Author

    Hi @lirenhe ,
    I see that AVOCDO test failed - as far i understand - it's related to readme file.
    I can see readme file in marketplace directory but it's looks like auto generated file.
    How can I generate that file? there is any documentation for avocado test and readme file?
    Thanks!

    @rkmanda rkmanda removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Sep 14, 2022
    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 14, 2022
    @lirenhe
    Copy link
    Member

    lirenhe commented Sep 16, 2022

    @tomercigler, could you fix the tool check errors in the PR? thanks

    @lirenhe lirenhe added the Reviewed-ChangesRequested <valid label in PR review process>add this label when assignee request changes after review label Sep 16, 2022
    @rkmanda rkmanda added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Sep 16, 2022
    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 16, 2022
    @tomercigler
    Copy link
    Contributor Author

        },
    

    +1

    x-ms-pageable doesn't work for POST. You should remove it.

    In reply to: 1254190054

    Refers to: specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2022-09-01/Marketplace.json:948 in e8d4dee. [](commit_id = e8d4dee, deletion_comment = False)

    Fixed, thanks

    @tomercigler
    Copy link
    Contributor Author

      "post": {
    

    It looks like this should be implemented by as part of the existing PUT method on the collection instance (or a new PATCH). You've added the "appliedRules" property to the CRUD payloads for privateStores/collections, so you should support updating that property as part of the regular CRUD methods. If you do that, you don't need to add this POST.

    Refers to: specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2022-09-01/Marketplace.json:873 in e8d4dee. [](commit_id = e8d4dee, deletion_comment = False)

      "post": {
    

    Can the client just GET the collection resource and access the appliedRules property, instead of adding this POST that [apparently] does the same thing?

    Refers to: specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2022-09-01/Marketplace.json:918 in e8d4dee. [](commit_id = e8d4dee, deletion_comment = False)

    About these 2 other comments.
    First, thank you for your review!
    We checked your comments and we decide to leave it as it is because:

    1. we are using that same way in other resources and API (all items approved, offers ...).
    2. we want to be more flexible with the user and give an option to get rules only in case that we don't need collection with all the fields.
    3. Our backend already after architecture, writing, testing, review and basically the swagger this is the last point we have left to finish this task.

    I see that there is new test failing - braking changes - something with enum changed, i checked that with few tools and im 100% sure that i didn't change that. Can you please help me understand what is the root cause?
    thanks!

    @mentat9 mentat9 removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Sep 29, 2022
    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 29, 2022
    @mentat9
    Copy link
    Member

    mentat9 commented Sep 29, 2022

    About these 2 other comments.
    First, thank you for your review!
    We checked your comments and we decide to leave it as it is because:

    we are using that same way in other resources and API (all items approved, offers ...).
    we want to be more flexible with the user and give an option to get rules only in case that we don't need collection with all the fields.
    Our backend already after architecture, writing, testing, review and basically the swagger this is the last point we have left to finish this task.

    It's not that it's wrong to add needed POST APIs, it's that it's not a good practice to have overlapping APIs. The feedback here is based on current ARM design and guidelines. There are 1000s of Azure APIs added over the past 8 years. These vary in degree of compliance with current guidelines: the past is not a guide to the future. I understand that making changes is hard: I'm not blocking ARM signoff on this.

    Two asks:

    1. Please use this feedback and track ARM guidance for future API designs.
    2. Please don't make your swagger check-in the final step in your process: it should be done as soon as possible in your API development in order to allow feedback and adjustments.

    @tomercigler
    Copy link
    Contributor Author

    Hi @mentat9
    Thank you for your review.
    I read and understood the things, I will make sure to pass them on to the rest of the team.
    I saw that you didn't approve the PR, are we waiting for something else or is it a mistake?

    @raych1
    Copy link
    Member

    raych1 commented Oct 3, 2022

    Hi @mentat9 , thank you very much for your great review. About the Breaking changes - this is a new API (you can see that i added that in that PR) so it can be breaking change. About the second comment - fix, thanks again!

    BTW we added more 1 API change, can you check that please?

    @tomercigler , see the details of cross version breaking change details which needs to get breaking change review approval.

    @raych1 raych1 added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Oct 3, 2022
    @raych1
    Copy link
    Member

    raych1 commented Oct 3, 2022

    Hi @mentat9 , thank you very much for your great review. About the Breaking changes - this is a new API (you can see that i added that in that PR) so it can be breaking change. About the second comment - fix, thanks again!
    BTW we added more 1 API change, can you check that please?

    @tomercigler , see the details of cross version breaking change details which needs to get breaking change review approval.

    I sampled checked the failures but seems they're false alarm. @jianyexi , can you confirm?

    @raych1 raych1 removed the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Oct 3, 2022
    @mentat9
    Copy link
    Member

    mentat9 commented Oct 3, 2022

    Hi @mentat9 Thank you for your review. I read and understood the things, I will make sure to pass them on to the rest of the team. I saw that you didn't approve the PR, are we waiting for something else or is it a mistake?

    @tomercigler - Sorry, I think you are right: I intended to sign off but didn't for whatever reason. One more thing to say about POST APIs (vs. GET/PUT/PATCH payloads) is that ARM features like Azure Policy and template deployments don't work with POST. That's the fundamental reason we favor putting as much capability into the CRUD resource model as possible. Customers expect to be able to use these basic ARM features, so when you ship APIs that bypass this functionality, it creates friction and frustration for them.

    @mentat9 mentat9 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Oct 3, 2022
    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 3, 2022
    @lirenhe
    Copy link
    Member

    lirenhe commented Oct 12, 2022

    The cross version breaking changes seem to be the false alarm. No action needed

    @lirenhe lirenhe removed the Reviewed-ChangesRequested <valid label in PR review process>add this label when assignee request changes after review label Oct 12, 2022
    @lirenhe lirenhe merged commit 8d482b2 into Azure:main Oct 12, 2022
    @openapi-pipeline-app openapi-pipeline-app bot added the Reviewed-ChangesRequested <valid label in PR review process>add this label when assignee request changes after review label Oct 12, 2022
    anandanthony pushed a commit to anandMicro/azure-rest-api-specs that referenced this pull request Dec 16, 2022
    * Clone 2022-03-01 to 2022-09-01
    
    * Add new private store api version 2022-09-01
    And new private store rules API
    
    * Fix from PR CR
    
    * Fix
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-FixRequiredOnFailure ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager Reviewed-ChangesRequested <valid label in PR review process>add this label when assignee request changes after review
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    6 participants