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

[Reservations][S360] Fixing reservation property by adding swapProperties #20905

Merged
merged 1 commit into from
Oct 5, 2022

Conversation

gaoyp830
Copy link
Contributor

@gaoyp830 gaoyp830 commented Sep 28, 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-pipeline-app
Copy link

openapi-pipeline-app bot commented Sep 28, 2022

Swagger Validation Report

️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]
compared swaggers (via Oad v0.9.7)] new version base version
reservations.json 2022-03-01(9e40eee) 2022-03-01(main)
Rule Message
1041 - AddedPropertyInResponse The new version has a new property 'swapProperties' in response that was not found in the old version.
New: Microsoft.Capacity/stable/2022-03-01/reservations.json#L2306:7
Old: Microsoft.Capacity/stable/2022-03-01/reservations.json#L2306:7
1041 - AddedPropertyInResponse The new version has a new property 'appliedScopeProperties' in response that was not found in the old version.
New: Microsoft.Capacity/stable/2022-03-01/reservations.json#L2306:7
Old: Microsoft.Capacity/stable/2022-03-01/reservations.json#L2306:7
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 2 Warnings warning [Detail]
compared tags (via openapi-validator v1.13.0) new version base version
package-2022-03 package-2022-03(9e40eee) package-2022-03(main)

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

Rule Message Related RPC [For API reviewers]
⚠️ R4021 - DescriptionAndTitleMissing 'AppliedScopeProperties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L2456
⚠️ R4021 - DescriptionAndTitleMissing 'ReservationSwapProperties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L2505


The following errors/warnings exist before current PR submission:

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

Rule Message
R4039 - ParametersOrder The parameters:reservationId,reservationOrderId should be kept in the same order as they present in the path.
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L487
R4039 - ParametersOrder The parameters:reservationId,reservationOrderId should be kept in the same order as they present in the path.
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L650
R4041 - XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L1304
R4041 - XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L1311
R4041 - XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L1451
R4041 - XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L1470
R4041 - XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L1487
R4041 - XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L1641
R4041 - XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L1855
R4041 - XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L2126
R4041 - XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L2133
R4041 - XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L2162
R4041 - XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L2169
R4041 - XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L2226
R4041 - XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L2445
R4041 - XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L2832
R4041 - XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L3047
⚠️ R1003 - ListInOperationName Since operation 'ReservationOrderChangeDirectory' 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.Capacity/stable/2022-03-01/reservations.json#L1011
⚠️ R1006 - PutInOperationName 'PUT' operation 'ReservationOrder_Purchase' 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.Capacity/stable/2022-03-01/reservations.json#L255
⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L1213
⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L1237
⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L1245
⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L1286
⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L1295
⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L1813
⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L1847
⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L1983
⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L1995
⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L2052
⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L2087
️⚠️Avocado: 1 Warnings warning [Detail]
Rule Message
⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
readme: specification/reservations/resource-manager/readme.md
tag: specification/reservations/resource-manager/readme.md#tag-package-2022-03
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
Validation passes for ServiceAPIReadinessTest.
️️✔️~[Staging] TrafficValidation 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: 0 Warnings warning [Detail]
  • The following tags are being changed in this PR
    • "https://github.com/Azure/azure-rest-api-specs/blob/9e40eee19138f252fe14e527067761d29580710f/specification/reservations/resource-manager/readme.md#tag-package-2022-03">reservations/resource-manager/readme.md#package-2022-03
The following errors/warnings exist before current PR submission:
Rule Message
⚠️ UnkownSecurityScheme "readme":"reservations/resource-manager/readme.md",
"tag":"package-2022-03",
"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
Copy link

openapi-pipeline-app bot commented Sep 28, 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-track2 succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from c89befd. SDK Automation 14.0.0
    command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
    warn	File azure-sdk-for-net_tmp/initOutput.json not found to read
    command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
  • ️✔️Azure.ResourceManager.Reservations [View full logs]  [Release SDK Changes]
    info	[Changelog]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from c89befd. 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
  • ️✔️track2_azure-mgmt-reservations [View full logs]  [Release SDK Changes]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog]   - Model ReservationsProperties has a new parameter applied_scope_properties
    info	[Changelog]   - Model ReservationsProperties has a new parameter swap_properties
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from c89befd. 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/reservations/armreservations [View full logs]  [Release SDK Changes]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog] - New struct `AppliedScopeProperties`
    info	[Changelog] - New struct `ReservationSwapProperties`
    info	[Changelog] - New field `AppliedScopeProperties` in struct `Properties`
    info	[Changelog] - New field `SwapProperties` in struct `Properties`
    info	[Changelog]
    info	[Changelog] Total 0 breaking change(s), 5 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from c89befd. 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
  • ️✔️@azure/arm-reservations [View full logs]  [Release SDK Changes]
    info	[Changelog] **Features**
    info	[Changelog]
    info	[Changelog]   - Added Interface AppliedScopeProperties
    info	[Changelog]   - Added Interface ReservationSwapProperties
    info	[Changelog]   - Interface ReservationsProperties has a new optional parameter appliedScopeProperties
    info	[Changelog]   - Interface ReservationsProperties has a new optional parameter swapProperties
️⚠️ azure-resource-manager-schemas warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from c89befd. 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
  • ️✔️reservations [View full logs
️️✔️ azure-powershell succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from c89befd. 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.ReservationApi [View full logs]  [Release SDK Changes]
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Sep 28, 2022

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/reservations/armreservations Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
Python track2_azure-mgmt-reservations Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
Java azure-resourcemanager-reservations Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
.Net Azure.ResourceManager.Reservations Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
JavaScript @azure/arm-reservations Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

@gaoyp830
Copy link
Contributor Author

@gaoyp830
Copy link
Contributor Author

Breaking change intake form: https://msazure.visualstudio.com/One/_workitems/edit/15662363

@openapi-workflow-bot
Copy link

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

@jianyexi jianyexi added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Sep 29, 2022
@mikekistler mikekistler added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Oct 3, 2022
@gaoyp830
Copy link
Contributor Author

gaoyp830 commented Oct 4, 2022

@xiaoxuqi-ms this breaking change has been approved, please review and merge this PR if it looks good to you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required FixS360 ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants