Patch reservations microsoft.capacity 2022 11 01 #22622

chchen3 · 2023-02-15T00:37:47Z

ARM API Information (Control Plane)

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for this PR by answering the following questions:

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify - update existing version to fix issue with SDK, gap in response, and better description
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

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

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

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

openapi-workflow-bot · 2023-02-15T00:37:50Z

Hi, @chchen3 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 · 2023-02-15T00:37:52Z

Swagger Validation Report

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

compared swaggers (via Oad v0.10.4)]	new version	base version
reservations.json	2022-11-01(ffdb0a2)	2022-11-01(main)

Rule	Message
`❌` 1011 - AddingResponseCode	The new version adds a response code '200'. New: Microsoft.Capacity/stable/2022-11-01/reservations.json#L870:11
`❌` 1041 - AddedPropertyInResponse	The new version has a new property 'p3Y' in response that was not found in the old version. New: Microsoft.Capacity/stable/2022-11-01/reservations.json#L1590:11 Old: Microsoft.Capacity/stable/2022-11-01/reservations.json#L1584:11
`❌` 1041 - AddedPropertyInResponse	The new version has a new property 'p5Y' in response that was not found in the old version. New: Microsoft.Capacity/stable/2022-11-01/reservations.json#L1590:11 Old: Microsoft.Capacity/stable/2022-11-01/reservations.json#L1584:11

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

There are no breaking changes.

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

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v2.0.0)	new version	base version
package-2022-11	package-2022-11(ffdb0a2)	package-2022-11(main)

The following errors/warnings exist before current PR submission:

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

Rule	Message
`❌` PostOperationAsyncResponseValidation	An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L31
`❌` PostOperationAsyncResponseValidation	An async POST operation must return 202. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L58
`❌` AllResourcesMustHaveDelete	The resource ReservationOrderResponse does not have a corresponding delete operation. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L272
`❌` PathForPutOperation	The path for 'put' operation must be under a subscription and resource group. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L272
`❌` CreateOperationAsyncResponseValidation	An async PUT operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'azure-async-operation' on 'x-ms-long-running-operation-options' Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L273
`❌` LongRunningResponseStatusCode	A 'put' operation 'ReservationOrder_Purchase' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L273
`❌` CreateOperationAsyncResponseValidation	An async PUT operation must return 201. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L300
`❌` CreateOperationAsyncResponseValidation	Only 201 is the supported response code for PUT async response. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L307
`❌` TrackedResourcesMustHavePut	The tracked resource ReservationResponse does not have a corresponding put operation. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L540
`❌` ConsistentPatchProperties	The property 'properties.name' in the request body either not apppear in the resource model or has the wrong level. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L605
`❌` PatchSkuProperty	The patch operation body parameter schema should contains property 'sku'. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L605
`❌` PostOperationAsyncResponseValidation	An async POST operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L897
`❌` PostOperationAsyncResponseValidation	An async POST operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L956
`❌` ProvisioningStateValidation	ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L1199
`❌` TopLevelResourcesListBySubscription	The top-level resource 'ReservationOrderResponse' does not have list by subscription operation, please add it. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L1687
⚠️ LongRunningOperationsOptionsValidator	A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L30
⚠️ XmsLongRunningOperationOptions	The x-ms-long-running-operation-options should be specified explicitly to indicate the type of response header to track the async operation. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L31
⚠️ ListInOperationName	Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L75
⚠️ PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'calculateprice' in:'ReservationOrder_Calculate'. Consider updating the operationId Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L202
⚠️ 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: 'ReservationOrder_Purchase' Request Model: 'parameters[2].schema' Response Model: 'responses[200].schema' Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L273
⚠️ 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-11-01/reservations.json#L276
⚠️ PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'calculaterefund' in:'CalculateRefund_Post'. Consider updating the operationId Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L805
⚠️ PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'return' in:'Return_Post'. Consider updating the operationId Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L845
⚠️ PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'calculateexchange' in:'CalculateExchange_Post'. Consider updating the operationId Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L900
⚠️ PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'exchange' in:'Exchange_Post'. Consider updating the operationId Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L959
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L1296
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L1321
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L1330
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L1373
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L1382

️⚠️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-11

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

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

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

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

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

️️✔️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 · 2023-02-15T00:37:53Z

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 - sdk/resourcemanager/reservations/armreservations - Approved - 3.0.0

+	Field `RefundResponse` of struct `ReturnClientPostResponse` has been removed

❌azure-sdk-for-js - @azure/arm-reservations - Approved - 9.0.0

+	Delete parameters of RefundResponse in TypeAlias ReturnPostResponse
+	Delete parameters of ReturnPostHeaders in TypeAlias ReturnPostResponse

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

❌Failed [Logs]Release - Generate from 49b2b96. 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
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:672
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 672 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to generate sdk. exit code: False
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGet-ChildItem: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:760
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 760 | �[0m … rtifacts += �[36;1mGet-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s�[0m …
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mCannot find path
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m'/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1mit does not exist.
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:672
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 672 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to generate sdk artifact
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m

❌Azure.ResourceManager.Reservations [View full logs] [Release SDK Changes]
```
info	[Changelog]
```

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

⚠️Warning [Logs]Release - Generate from 49b2b96. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh] npm notice
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.3.1 -> 9.6.0
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.0>
cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-reservations [View full logs] [Release SDK Changes]

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Model CatalogMsrp has a new parameter p3_y
info	[Changelog]   - Model CatalogMsrp has a new parameter p5_y

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

️✔️Succeeded [Logs]Release - Generate from 49b2b96. 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] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Field `RefundResponse` of struct `ReturnClientPostResponse` has been removed
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New field `P3Y` in struct `CatalogMsrp`
info	[Changelog] - New field `P5Y` in struct `CatalogMsrp`
info	[Changelog] - New anonymous field `ReservationOrderResponse` in struct `ReturnClientPostResponse`
info	[Changelog]
info	[Changelog] Total 1 breaking change(s), 2 additive change(s).

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

️✔️Succeeded [Logs]Release - Generate from 49b2b96. 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] Breaking Change Detected

azure-arm-reservations-9.0.0.tgz

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Interface CatalogMsrp has a new optional parameter p3Y
info	[Changelog]   - Interface CatalogMsrp has a new optional parameter p5Y
info	[Changelog]
info	[Changelog] **Breaking Changes**
info	[Changelog]
info	[Changelog]   - Delete parameters of ReturnPostHeaders in TypeAlias ReturnPostResponse
info	[Changelog]   - Delete parameters of RefundResponse in TypeAlias ReturnPostResponse

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

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

️✔️reservations [View full logs] [Release Schema Changes]

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

️✔️Succeeded [Logs]Release - Generate from 49b2b96. 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]
- Az.ReservationApi.0.1.0.nupkg

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

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

command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json

️✔️azure-resourcemanager-reservations [View full logs] [Release SDK Changes]

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

openapi-pipeline-app · 2023-02-15T00:37:54Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/reservations/armreservations	https://apiview.dev/Assemblies/Review/c9c6c2582b1d462e8cca3ac9f46afe59
Java	azure-resourcemanager-reservations	https://apiview.dev/Assemblies/Review/59d0256b7e5a4d698f5a23da2beb99dd
JavaScript	@azure/arm-reservations	https://apiview.dev/Assemblies/Review/615669f5291b4a1588c223570b61abef

openapi-workflow-bot · 2023-02-15T00:46:05Z

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

…troduce 200

openapi-workflow-bot · 2023-02-27T19:18:37Z

Hi @chchen3, 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 · 2023-02-27T19:18:37Z

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.

…upport final-state-schema

gaoyp830 · 2023-03-02T00:06:16Z

...tion/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/Return.json

+          "displayName": "cabri",
+          "requestDateTime": "2017-08-30T03:49:19.0252126Z",
+          "createdDateTime": "2017-08-30T03:51:49.8083758Z",
+          "expiryDate": "2018-08-30",


We are not returning expiryDate in getOrder api I believe, can you remove this?

We are now adding in the response

* Add 200 responses for Return to fix SDK * Add additional non required property and extra info in description * Add p3Y, p5Y for msrp response. Fix typo * update example to use reservationOrder call * remove instanceFlexibility which will be deprecated in the near future * add final state schema in long running operations field instead of introduce 200 * add 200 back since azure cli and powershell currently still doesn't support final-state-schema

chchen3 added 2 commits February 14, 2023 15:23

Add 200 responses for Return to fix SDK

ce77098

Add additional non required property and extra info in description

16a5753

openapi-assignment-bot bot assigned tadelesh Feb 15, 2023

openapi-workflow-bot bot added the FixS360 label Feb 15, 2023

chchen3 requested a review from gaoyp830 February 15, 2023 00:38

azure-sdk mentioned this pull request Feb 15, 2023

[AutoPR reservations] Patch reservations microsoft.capacity 2022 11 01 azure-sdk/azure-resource-manager-schemas#2012

Closed

AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required resource-manager labels Feb 15, 2023

azure-sdk mentioned this pull request Feb 15, 2023

[AutoPR sdk/resourcemanager/reservations/armreservations] Patch reservations microsoft.capacity 2022 11 01 azure-sdk/azure-sdk-for-go#4429

Closed

openapi-pipeline-app bot added the CI-BreakingChange-Go label Feb 15, 2023

openapi-pipeline-app bot added the CI-BreakingChange-Python-Track2 label Feb 15, 2023

azure-sdk mentioned this pull request Feb 15, 2023

[AutoPR @azure/arm-reservations] Patch reservations microsoft.capacity 2022 11 01 azure-sdk/azure-sdk-for-js#3923

Closed

openapi-pipeline-app bot added the CI-BreakingChange-JavaScript label Feb 15, 2023

chchen3 added 3 commits February 15, 2023 15:12

Add p3Y, p5Y for msrp response. Fix typo

83f306d

update example to use reservationOrder call

308df1d

remove instanceFlexibility which will be deprecated in the near future

ec68e17

mikekistler added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Feb 27, 2023

add final state schema in long running operations field instead of in…

d88c5ba

…troduce 200

AzureRestAPISpecReview added CI-FixRequiredOnFailure NewApiVersionRequired and removed BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required labels Feb 27, 2023

add 200 back since azure cli and powershell currently still doesn't s…

ffdb0a2

…upport final-state-schema

AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required and removed NewApiVersionRequired CI-FixRequiredOnFailure labels Mar 1, 2023

gaoyp830 reviewed Mar 2, 2023

View reviewed changes

tadelesh added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Mar 2, 2023

MaryGao added the Approved-SdkBreakingChange-JavaScript label Mar 2, 2023

tadelesh approved these changes Mar 2, 2023

View reviewed changes

tadelesh merged commit 49b2b96 into Azure:main Mar 2, 2023

tadelesh mentioned this pull request Mar 21, 2023

[Release] sdk/resourcemanager/reservations/armreservations/3.0.0 Azure/azure-sdk-for-go#20363

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Patch reservations microsoft.capacity 2022 11 01 #22622

Patch reservations microsoft.capacity 2022 11 01 #22622

chchen3 commented Feb 15, 2023 •

edited

Loading

openapi-workflow-bot bot commented Feb 15, 2023

openapi-pipeline-app bot commented Feb 15, 2023 •

edited

Loading

openapi-pipeline-app bot commented Feb 15, 2023 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented Feb 15, 2023 •

edited

Loading

openapi-workflow-bot bot commented Feb 15, 2023

openapi-workflow-bot bot commented Feb 27, 2023

openapi-workflow-bot bot commented Feb 27, 2023

gaoyp830 Mar 2, 2023

chchen3 Mar 2, 2023

Patch reservations microsoft.capacity 2022 11 01 #22622

Patch reservations microsoft.capacity 2022 11 01 #22622

Conversation

chchen3 commented Feb 15, 2023 • edited Loading

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Feb 15, 2023

openapi-pipeline-app bot commented Feb 15, 2023 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Feb 15, 2023 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Feb 15, 2023 • edited Loading

Generated ApiView

openapi-workflow-bot bot commented Feb 15, 2023

openapi-workflow-bot bot commented Feb 27, 2023

openapi-workflow-bot bot commented Feb 27, 2023

gaoyp830 Mar 2, 2023

Choose a reason for hiding this comment

chchen3 Mar 2, 2023

Choose a reason for hiding this comment

chchen3 commented Feb 15, 2023 •

edited

Loading

openapi-pipeline-app bot commented Feb 15, 2023 •

edited

Loading

openapi-pipeline-app bot commented Feb 15, 2023 •

edited

Loading

openapi-pipeline-app bot commented Feb 15, 2023 •

edited

Loading