UsageV3 S360 Updates #22637

JoeBeach-msft · 2023-02-15T17:09:38Z

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

Contribution checklist (MS Employees Only):

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

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

ARM API Review Checklist

Applicability: ⚠️

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

Change to data plane APIs

Adding new properties

All removals

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

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

Breaking Change Review Checklist

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

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

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

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

UsageV3 S360 Updates

Added definitions for 202 responses and added 'error' as a property to definition for 'ErrorResponse'.

These changes were made to correct the below three items that were flagging for swagger compliance in S360.

Corrected three items that were flagging for swagger compliance in S360. Added definitions for 202 responses and added 'error' as a property to definition for 'ErrorResponse'.

openapi-workflow-bot · 2023-02-15T17:09:42Z

Hi, @JoeBeach-msft 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-15T17:09:43Z

Swagger Validation Report

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

compared swaggers (via Oad v0.10.4)]	new version	base version
commerce.json	2015-06-01-preview(c80b871)	2015-06-01-preview(main)

Rule	Message
`❌` 1011 - AddingResponseCode	The new version adds a response code '202'. New: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L96:11
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'project' renamed or removed? Old: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L153:7

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

There are no breaking changes.

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

There is no credential detected.

️❌LintDiff: 2 Errors, 1 Warnings failed [Detail]

compared tags (via openapi-validator v2.0.0)	new version	base version
profile-hybrid-2020-09-01	profile-hybrid-2020-09-01(c80b871)	profile-hybrid-2020-09-01(main)

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

Rule	Message	Related RPC [For API reviewers]
`❌` GetOperation200	The get operation should only return 200. Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L96	RPC-Get-V1-01
`❌` LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L96	RPC-Async-V1-07
⚠️ LroExtension	Operations with a 202 response should specify `x-ms-long-running-operation: true`. Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L21

The following errors/warnings exist before current PR submission:

Rule	Message
`❌` OperationsAPIImplementation	Operations API must be implemented for 'Microsoft.Commerce'. Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L1
`❌` PathResourceTypeNameCamelCase	Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/providers/Microsoft.Commerce/UsageAggregates' Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L20
`❌` DefaultErrorResponseSchema	the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L102
`❌` PathResourceTypeNameCamelCase	Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/providers/Microsoft.Commerce/RateCard' Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L114
`❌` DefaultErrorResponseSchema	the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L151
`❌` MissingTypeObject	The schema 'UsageSample' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L166
`❌` GuidUsage	Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L170
`❌` MissingTypeObject	The schema 'UsageAggregation' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L223
`❌` MissingTypeObject	The schema 'UsageAggregationListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L245
`❌` MissingTypeObject	The schema 'RateCardQueryParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L261
`❌` MissingTypeObject	The schema 'ResourceRateCardInfo' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L289
`❌` MissingTypeObject	The schema 'MeterInfo' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L326
`❌` GuidUsage	Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L332
`❌` MissingTypeObject	The schema 'OfferTermInfo' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L381
`❌` MissingTypeObject	The schema 'MonetaryCredit' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L408
`❌` ValidFormats	'decimal' is not a known format. Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L420
`❌` GuidUsage	Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L427
`❌` MissingTypeObject	The schema 'MonetaryCommitment' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L432
`❌` ValidFormats	'decimal' is not a known format. Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L446
`❌` GuidUsage	Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L454
`❌` MissingTypeObject	The schema 'RecurringCharge' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L459
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L468
`❌` XmsParameterLocation	The parameter 'SubscriptionIdParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L490
`❌` XmsParameterLocation	The parameter 'ApiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L497
⚠️ PreviewVersionOverOneYear	The API version:2015-06-01-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L5
⚠️ NonApplicationJsonType	Only content-type 'application/json' is supported by ARM Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L13
⚠️ NonApplicationJsonType	Only content-type 'application/json' is supported by ARM Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L17
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L52
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Commerce/preview/2015-06-01-preview/commerce.json#L300

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

Validation passes for Avocado.

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

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

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

️️✔️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-15T17:09:44Z

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/commerce/armcommerce - 0.2.0

+	Field `UsageAggregationListResult` of struct `UsageAggregatesClientListResponse` has been removed
+	Struct `InfoField` has been removed

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

⚠️Warning [Logs]Release - Generate from 85a2e04. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh]
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 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-commerce [View full logs] [Release SDK Changes]
- azure-mgmt-commerce-1.0.0b1.zip
- azure_mgmt_commerce-1.0.0b1-py3-none-any.whl
```
info	[Changelog]
```

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

❌Failed [Logs]Release - Generate from 85a2e04. 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-commerce [View full logs] [Release SDK Changes]
- pom.xml

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

️✔️Succeeded [Logs]Release - Generate from 85a2e04. 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/commerce/armcommerce [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Struct `InfoField` has been removed
info	[Changelog] - Field `UsageAggregationListResult` of struct `UsageAggregatesClientListResponse` has been removed
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - Type of `UsageSample.InfoFields` has been changed from `*InfoField` to `any`
info	[Changelog] - New field `Value` in struct `UsageAggregatesClientListResponse`
info	[Changelog]
info	[Changelog] Total 4 breaking change(s), 1 additive change(s).

️🔄 azure-sdk-for-js inProgress [Detail]

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

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

️✔️commerce [View full logs]

️❌ azure-powershell failed [Detail]

❌Failed [Logs]Release - Generate from 85a2e04. 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.commerce [View full logs] [Release SDK Changes]

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

openapi-pipeline-app · 2023-02-15T17:09:45Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/commerce/armcommerce	https://apiview.dev/Assemblies/Review/01483dfacd4a4ed58957b05378ef64a5

...cation/commerce/resource-manager/Microsoft.Commerce/preview/2015-06-01-preview/commerce.json

openapi-workflow-bot · 2023-02-15T17:17:48Z

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

Removed the 202 response for Ratecard Ratecard is a different service that is not getting flagged for in S360 and does not support 202 response code.

Swagger will not let ErrorResponse contain an error property with subproperties. Reverting ErrorResponse to contain "code" and "message" as its properties.

openapi-workflow-bot · 2023-02-15T23:04:33Z

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

Ran prettier in order to address Pull Request check.

Added xm-ms-long-running-operation Property to the UsageAggregates_List get call in order to justify the addition of the 202 response.

Added x-ms-long-running-operation-options. Adding a 202 response requires that these options be set.

Reran prettier after the last commit to correct formatting issues.

Added x-ms-example for GetUsageAggregates_List. PR check was flagging because there was no example present. Will create the referenced json file in the next commit.

openapi-workflow-bot · 2023-02-25T02:04:51Z

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

Removed all subproperties for InfoFields. Our api no longer returns any properties for InfoFields.

Removed Infofields properties. Our api no longer returns any of these properties in a 200 response.

Removed Property from InfoFields. This should have been removed along with the other properties in the previous commit.

...cation/commerce/resource-manager/Microsoft.Commerce/preview/2015-06-01-preview/commerce.json

Removed longrunning operation from UsageAggregates_List.

...cation/commerce/resource-manager/Microsoft.Commerce/preview/2015-06-01-preview/commerce.json

Location header no longer needed.

weidongxu-microsoft · 2023-03-03T03:38:29Z

...cation/commerce/resource-manager/Microsoft.Commerce/preview/2015-06-01-preview/commerce.json

+          "202": {
+            "description": "Response indicating that a request has been accepted for processing. However, the processing has not been completed.",
+            "schema": {
+              "$ref": "#/definitions/ErrorResponse"


This 202 is wrong.

Why 202 returns ErrorResponse?

And what 202 do for a GET (and it is not LRO)?

* UsageV3 S360 Updates Corrected three items that were flagging for swagger compliance in S360. Added definitions for 202 responses and added 'error' as a property to definition for 'ErrorResponse'. * Removed 202 Response for Ratecard Removed the 202 response for Ratecard Ratecard is a different service that is not getting flagged for in S360 and does not support 202 response code. * Undo ErrorMessage Properties Swagger will not let ErrorResponse contain an error property with subproperties. Reverting ErrorResponse to contain "code" and "message" as its properties. * Ran Prettier Ran prettier in order to address Pull Request check. * Added xm-ms-long-running-operation Property Added xm-ms-long-running-operation Property to the UsageAggregates_List get call in order to justify the addition of the 202 response. * Added x-ms-long-running-operation-options Added x-ms-long-running-operation-options. Adding a 202 response requires that these options be set. * Prettier Run Reran prettier after the last commit to correct formatting issues. * Added x-ms-example for GetUsageAggregates_List Added x-ms-example for GetUsageAggregates_List. PR check was flagging because there was no example present. Will create the referenced json file in the next commit. * Added example file for UsageAggregates List There was previously no example for UsageAggregates List, but there was one for RateCard. The following documentation was used to generate this example file. https://learn.microsoft.com/en-us/previous-versions/azure/reference/mt219001(v=azure.100)?redirectedfrom=MSDN#sample-responses * Corrected Formatting for UsageAggregatesList Example Value Array was missing brackets for its element. * Corrected Example File Name Corrected the file name to exclude an underscore. * Added Location Header to 202 Response Added location header to the 202 response. * Corrected Location to use double quotes Corrected formatting issue with the previous commit that added a location header to the 202 response. * Updated Example Fields Updated infofields to match the example given in the api documentation. * Added 202 Response Added a 202 response to the example file. * GetUsageAggregatesList.json Prettier Update Reran Prettier script on GetUsageAggregatesList.json * Updated case 'Daily' and Example 202 Response Updated case 'Daily' and Example 202 Response. These changes were made previously, but lost at some point. * Removed Error from 202 Body Error property not allowed in the response. * Removed InfoFields properties. Removed all subproperties for InfoFields. Our api no longer returns any properties for InfoFields. * Removed Infofields properties. Removed Infofields properties. Our api no longer returns any of these properties in a 200 response. * Removed InfoFields Properties Removed Property from InfoFields. This should have been removed along with the other properties in the previous commit. * Removed LongRunning operation Removed longrunning operation from UsageAggregates_List. * Removed Location Header Location header no longer needed.

UsageV3 S360 Updates

aee0c7f

Corrected three items that were flagging for swagger compliance in S360. Added definitions for 202 responses and added 'error' as a property to definition for 'ErrorResponse'.

JoeBeach-msft added the Swagger Cleanup Indicating refactor/cleanup work needed label Feb 15, 2023

JoeBeach-msft requested a review from peteokos February 15, 2023 17:09

JoeBeach-msft self-assigned this Feb 15, 2023

peteokos reviewed Feb 15, 2023

View reviewed changes

...cation/commerce/resource-manager/Microsoft.Commerce/preview/2015-06-01-preview/commerce.json Outdated Show resolved Hide resolved

AzureRestAPISpecReview added CI-FixRequiredOnFailure resource-manager labels Feb 15, 2023

This was referenced Feb 15, 2023

[AutoPR azure-resourcemanager-commerce] UsageV3 S360 Updates azure-sdk/azure-sdk-for-java#3944

Closed

[AutoPR Az.commerce] UsageV3 S360 Updates azure-sdk/azure-powershell#4365

Closed

Removed 202 Response for Ratecard

ec6e963

Removed the 202 response for Ratecard Ratecard is a different service that is not getting flagged for in S360 and does not support 202 response code.

peteokos approved these changes Feb 15, 2023

View reviewed changes

Undo ErrorMessage Properties

db07b08

Swagger will not let ErrorResponse contain an error property with subproperties. Reverting ErrorResponse to contain "code" and "message" as its properties.

azure-sdk mentioned this pull request Feb 15, 2023

[AutoPR sdk/resourcemanager/commerce/armcommerce] UsageV3 S360 Updates azure-sdk/azure-sdk-for-go#4456

Closed

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

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

azure-sdk mentioned this pull request Feb 15, 2023

[AutoPR track2_azure-mgmt-commerce] UsageV3 S360 Updates azure-sdk/azure-sdk-for-python#2782

Closed

JoeBeach-msft added 2 commits February 17, 2023 08:51

Ran Prettier

84ba8cf

Ran prettier in order to address Pull Request check.

Added xm-ms-long-running-operation Property

3100822

Added xm-ms-long-running-operation Property to the UsageAggregates_List get call in order to justify the addition of the 202 response.

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

JoeBeach-msft added 3 commits February 17, 2023 15:27

Added x-ms-long-running-operation-options

d06261e

Added x-ms-long-running-operation-options. Adding a 202 response requires that these options be set.

Prettier Run

965a325

Reran prettier after the last commit to correct formatting issues.

Added x-ms-example for GetUsageAggregates_List

fe55db3

Added x-ms-example for GetUsageAggregates_List. PR check was flagging because there was no example present. Will create the referenced json file in the next commit.

azure-sdk mentioned this pull request Feb 17, 2023

[AutoPR Az.Usage] UsageV3 S360 Updates azure-sdk/azure-powershell#4400

Closed

AzureRestAPISpecReview removed the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Feb 17, 2023

openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Feb 25, 2023

JoeBeach-msft added 3 commits February 27, 2023 10:56

Removed InfoFields properties.

09e8436

Removed all subproperties for InfoFields. Our api no longer returns any properties for InfoFields.

Removed Infofields properties.

00f2b16

Removed Infofields properties. Our api no longer returns any of these properties in a 200 response.

Removed InfoFields Properties

95bf03e

Removed Property from InfoFields. This should have been removed along with the other properties in the previous commit.

peteokos approved these changes Mar 1, 2023

View reviewed changes

pilor reviewed Mar 1, 2023

View reviewed changes

...cation/commerce/resource-manager/Microsoft.Commerce/preview/2015-06-01-preview/commerce.json Outdated Show resolved Hide resolved

xiaoxuqi-ms assigned xiaoxuqi-ms and unassigned JoeBeach-msft Mar 2, 2023

xiaoxuqi-ms reviewed Mar 2, 2023

View reviewed changes

...cation/commerce/resource-manager/Microsoft.Commerce/preview/2015-06-01-preview/commerce.json Show resolved Hide resolved

Removed LongRunning operation

01250ea

Removed longrunning operation from UsageAggregates_List.

pilor reviewed Mar 2, 2023

View reviewed changes

...cation/commerce/resource-manager/Microsoft.Commerce/preview/2015-06-01-preview/commerce.json Outdated Show resolved Hide resolved

pilor removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Mar 2, 2023

openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Mar 2, 2023

pilor added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Mar 2, 2023

Removed Location Header

c80b871

Location header no longer needed.

xiaoxuqi-ms added the Approved-LintDiff label Mar 3, 2023

xiaoxuqi-ms approved these changes Mar 3, 2023

View reviewed changes

xiaoxuqi-ms merged commit 85a2e04 into main Mar 3, 2023

xiaoxuqi-ms deleted the JoeBeach-msft-commerce-Microsoft.Commerce-2015-06-01-preview branch March 3, 2023 01:05

weidongxu-microsoft reviewed Mar 3, 2023

View reviewed changes

jeffmcco-msft mentioned this pull request Mar 18, 2023

[Hub Generated] Review request for Microsoft.Commerce to add version preview/2015-06-01-preview #23172

Merged

11 tasks

jeffmcco-msft mentioned this pull request Mar 29, 2023

[Hub Generated] Review request for Microsoft.Commerce to add version preview/2015-06-01-preview #23363

Merged

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

UsageV3 S360 Updates #22637

UsageV3 S360 Updates #22637

JoeBeach-msft commented Feb 15, 2023 •

edited by jeffmcco-msft

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 15, 2023

openapi-workflow-bot bot commented Feb 25, 2023

weidongxu-microsoft Mar 3, 2023

weidongxu-microsoft Mar 3, 2023 •

edited

Loading

UsageV3 S360 Updates #22637

UsageV3 S360 Updates #22637

Conversation

JoeBeach-msft commented Feb 15, 2023 • edited by jeffmcco-msft Loading

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

UsageV3 S360 Updates

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 15, 2023

openapi-workflow-bot bot commented Feb 25, 2023

weidongxu-microsoft Mar 3, 2023

Choose a reason for hiding this comment

weidongxu-microsoft Mar 3, 2023 • edited Loading

Choose a reason for hiding this comment

JoeBeach-msft commented Feb 15, 2023 •

edited by jeffmcco-msft

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

weidongxu-microsoft Mar 3, 2023 •

edited

Loading