Adding missing customerName property to fix S360 swagger correctness #23948

us6193 · 2023-05-12T01:16:29Z

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.

To fix the below S360 item:
https://vnext.s360.msftcloudes.com/blades/unifiedplatform?blade=AssignedTo:All~KPI:cf751b97-2c95-420f-baa8-9a16e8643a5b~SLA:1~Forums:All~_loc:UnifiedPlatform&def=&peopleBasedNodes=anr_team;vikdesai_team&tile=S360_ServiceId:a9305e6b-3d6c-477c-b3cf-1a81498037be~_loc:__key__UnifiedPlatform__cf751b97-2c95-420f-baa8-9a16e8643a5b&global=4:a9305e6b-3d6c-477c-b3cf-1a81498037be

https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=503AA620-9782-4684-86AA-7E648EFE46E0

Changelog

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

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month. - NA
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. - NA
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-05-12T01:16:32Z

Hi, @us6193 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-05-12T01:16:35Z

Swagger Validation Report

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

compared swaggers (via Oad v0.10.4)]	new version	base version
billingSubscription.json	2021-10-01(899d1e6)	2021-10-01(main)

Rule	Message
`❌` 1040 - AddedReadOnlyPropertyInResponse	The new version has a new read-only property 'customerName' in response that was not found in the old version. New: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L682:7 Old: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L682:7
`❌` 1040 - AddedReadOnlyPropertyInResponse	The new version has a new read-only property 'customerName' in response that was not found in the old version. New: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L1140:7 Old: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L1135:7
`❌` 1045 - AddedOptionalProperty	The new version has a new optional property 'customerName' that was not found in the old version. New: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L682:7 Old: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L682:7
`❌` 1045 - AddedOptionalProperty	The new version has a new optional property 'customerName' that was not found in the old version. New: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L1140:7 Old: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L1135:7

️️✔️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.1.1)	new version	base version
package-2021-10	package-2021-10(899d1e6)	package-2021-10(main)

The following errors/warnings exist before current PR submission:

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

Rule	Message
`❌` ResourceNameRestriction	The resource name parameter 'billingAccountName' should be defined with a 'pattern' restriction. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L19
`❌` GetCollectionOnlyHasValueAndNextLink	Get endpoints for collections of resources must only have the `value` and `nextLink` properties in their model. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L45
`❌` ResourceNameRestriction	The resource name parameter 'billingAccountName' should be defined with a 'pattern' restriction. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L61
`❌` ResourceNameRestriction	The resource name parameter 'billingSubscriptionName' should be defined with a 'pattern' restriction. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L61
`❌` UnSupportedPatchProperties	The patch operation body parameter schema should not contains property name. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L127
`❌` UnSupportedPatchProperties	The patch operation body parameter schema should not contains property type. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L127
`❌` ProvisioningStateSpecifiedForLROPatch	200 response schema in long running PATCH operation is missing ProvisioningState property. A LRO PATCH operations 200 response schema must have ProvisioningState specified. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L138
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L161
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L219
`❌` ResourceNameRestriction	The resource name parameter 'billingAccountName' should be defined with a 'pattern' restriction. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L225
`❌` ResourceNameRestriction	The resource name parameter 'billingSubscriptionName' should be defined with a 'pattern' restriction. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L225
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L285
`❌` ResourceNameRestriction	The resource name parameter 'billingAccountName' should be defined with a 'pattern' restriction. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L291
`❌` ResourceNameRestriction	The resource name parameter 'billingSubscriptionName' should be defined with a 'pattern' restriction. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L291
`❌` ResourceNameRestriction	The resource name parameter 'billingAccountName' should be defined with a 'pattern' restriction. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L342
`❌` ResourceNameRestriction	The resource name parameter 'billingSubscriptionName' should be defined with a 'pattern' restriction. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L342
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L402
`❌` ResourceNameRestriction	The resource name parameter 'billingAccountName' should be defined with a 'pattern' restriction. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L408
`❌` ResourceNameRestriction	The resource name parameter 'billingSubscriptionName' should be defined with a 'pattern' restriction. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L408
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L468
`❌` ResourceNameRestriction	The resource name parameter 'billingAccountName' should be defined with a 'pattern' restriction. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L474
`❌` PathForPutOperation	The path for 'put' operation must be under a subscription and resource group. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L516
`❌` ResourceNameRestriction	The resource name parameter 'billingAccountName' should be defined with a 'pattern' restriction. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L516
`❌` ResourceNameRestriction	The resource name parameter 'aliasName' should be defined with a 'pattern' restriction. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L516
`❌` ProvisioningStateSpecifiedForLROPut	200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L557
`❌` ProvisioningStateSpecifiedForLROPut	201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L557
`❌` PutResponseSchemaDescription	Any Put MUST contain 200 and 201 return codes. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L589
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L613
⚠️ ParameterNotDefinedInGlobalParameters	Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L34
⚠️ RequiredReadOnlySystemData	The response of operation:'BillingSubscriptions_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Billing/stable/2021-10-01/billingSubscription.json#L62

️⚠️Avocado: 1 Warnings warning [Detail]

Rule	Message
⚠️ MULTIPLE_API_VERSION	The default tag contains multiple API versions swaggers. readme: specification/billing/resource-manager/readme.md tag: specification/billing/resource-manager/readme.md#tag-package-2020-05

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

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

️️✔️TypeSpec Validation succeeded [Detail] [Expand]

Validation passes for TypeSpec Validation.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

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

openapi-pipeline-app · 2023-05-12T01:16:36Z

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-js - @azure/arm-billing - Approved - 5.0.0-beta.1

+	Interface AgreementsListByBillingAccountNextOptionalParams no longer has parameter expand
+	Interface BillingAccountsListNextOptionalParams no longer has parameter expand
+	Interface BillingPeriodsListNextOptionalParams no longer has parameter filter
+	Interface BillingPeriodsListNextOptionalParams no longer has parameter skiptoken
+	Interface BillingPeriodsListNextOptionalParams no longer has parameter top
+	Interface BillingProfilesListByBillingAccountNextOptionalParams no longer has parameter expand
+	Interface CustomersListByBillingAccountNextOptionalParams no longer has parameter filter
+	Interface CustomersListByBillingAccountNextOptionalParams no longer has parameter search
+	Interface CustomersListByBillingProfileNextOptionalParams no longer has parameter filter
+	Interface CustomersListByBillingProfileNextOptionalParams no longer has parameter search
+	Interface ProductsListByBillingAccountNextOptionalParams no longer has parameter filter
+	Interface ProductsListByBillingProfileNextOptionalParams no longer has parameter filter
+	Interface ProductsListByInvoiceSectionNextOptionalParams no longer has parameter filter
+	Interface ReservationsListByBillingAccountNextOptionalParams no longer has parameter filter
+	Interface ReservationsListByBillingAccountNextOptionalParams no longer has parameter orderby
+	Interface ReservationsListByBillingAccountNextOptionalParams no longer has parameter refreshSummary
+	Interface ReservationsListByBillingAccountNextOptionalParams no longer has parameter selectedState
+	Interface ReservationsListByBillingProfileNextOptionalParams no longer has parameter filter
+	Interface ReservationsListByBillingProfileNextOptionalParams no longer has parameter orderby
+	Interface ReservationsListByBillingProfileNextOptionalParams no longer has parameter refreshSummary
+	Interface ReservationsListByBillingProfileNextOptionalParams no longer has parameter selectedState

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

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

️✔️Azure.ResourceManager.Billing [View full logs] [Release SDK Changes]
- Azure.ResourceManager.Billing.1.1.0-alpha.20230523.1.nupkg
```
info	[Changelog]
```

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

⚠️Warning [Logs]Release - Generate from 52fe502. 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.5.1 -> 9.6.7
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.7>
cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-billing [View full logs] [Release SDK Changes]
- azure_mgmt_billing-0.3.0-py3-none-any.whl
- azure-mgmt-billing-0.3.0.zip
```
info	[Changelog]
```

️⚠️ azure-sdk-for-java warning [Detail]

⚠️Warning [Logs]Release - Generate from 52fe502. 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
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json

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

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

️✔️Succeeded [Logs]Release - Generate from 52fe502. 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/billing/armbilling [View full logs] [Release SDK Changes]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

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

️✔️Succeeded [Logs]Release - Generate from 52fe502. 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-billing [View full logs] [Release SDK Changes] Breaking Change Detected

azure-arm-billing-5.0.0-beta.1.tgz

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added Interface BillingProfileInfo
info	[Changelog]   - Added Interface OperationsErrorDetails
info	[Changelog]   - Added Interface OperationsErrorResponse
info	[Changelog]   - Interface Agreement has a new optional parameter billingProfileInfo
info	[Changelog]   - Interface BillingProfileListResult has a new optional parameter totalCount
info	[Changelog]
info	[Changelog] **Breaking Changes**
info	[Changelog]
info	[Changelog]   - Interface AgreementsListByBillingAccountNextOptionalParams no longer has parameter expand
info	[Changelog]   - Interface BillingAccountsListNextOptionalParams no longer has parameter expand
info	[Changelog]   - Interface BillingPeriodsListNextOptionalParams no longer has parameter filter
info	[Changelog]   - Interface BillingPeriodsListNextOptionalParams no longer has parameter skiptoken
info	[Changelog]   - Interface BillingPeriodsListNextOptionalParams no longer has parameter top
info	[Changelog]   - Interface BillingProfilesListByBillingAccountNextOptionalParams no longer has parameter expand
info	[Changelog]   - Interface CustomersListByBillingAccountNextOptionalParams no longer has parameter filter
info	[Changelog]   - Interface CustomersListByBillingAccountNextOptionalParams no longer has parameter search
info	[Changelog]   - Interface CustomersListByBillingProfileNextOptionalParams no longer has parameter filter
info	[Changelog]   - Interface CustomersListByBillingProfileNextOptionalParams no longer has parameter search
info	[Changelog]   - Interface ProductsListByBillingAccountNextOptionalParams no longer has parameter filter
info	[Changelog]   - Interface ProductsListByBillingProfileNextOptionalParams no longer has parameter filter
info	[Changelog]   - Interface ProductsListByInvoiceSectionNextOptionalParams no longer has parameter filter
info	[Changelog]   - Interface ReservationsListByBillingAccountNextOptionalParams no longer has parameter filter
info	[Changelog]   - Interface ReservationsListByBillingAccountNextOptionalParams no longer has parameter orderby
info	[Changelog]   - Interface ReservationsListByBillingAccountNextOptionalParams no longer has parameter refreshSummary
info	[Changelog]   - Interface ReservationsListByBillingAccountNextOptionalParams no longer has parameter selectedState
info	[Changelog]   - Interface ReservationsListByBillingProfileNextOptionalParams no longer has parameter filter
info	[Changelog]   - Interface ReservationsListByBillingProfileNextOptionalParams no longer has parameter orderby
info	[Changelog]   - Interface ReservationsListByBillingProfileNextOptionalParams no longer has parameter refreshSummary
info	[Changelog]   - Interface ReservationsListByBillingProfileNextOptionalParams no longer has parameter selectedState

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

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

️✔️billing [View full logs]

️❌ azure-powershell failed [Detail]

❌Pipeline Framework Failed [Logs]Release - Generate from 52fe502. 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
SSL error: syscall failure: Broken pipe
Error: SSL error: syscall failure: Broken pipe

️✔️Az.billing.DefaultTag [View full logs]

Az.Billing.0.1.0.nupkg

error	Fatal error: SSL error: syscall failure: Broken pipe
error	The following packages are still pending:
error		Az.billing.DefaultTag

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

openapi-pipeline-app · 2023-05-12T01:16:36Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/billing/armbilling	There is no API change compared with the previous version
.Net	Azure.ResourceManager.Billing	https://apiview.dev/Assemblies/Review/84825d0702a243ac9f0eb3ff84478bdc
Java	azure-resourcemanager-billing	There is no API change compared with the previous version
JavaScript	@azure/arm-billing	https://apiview.dev/Assemblies/Review/eca9f46137dd42229904a0b179824000

openapi-workflow-bot · 2023-05-12T01:23:00Z

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.

openapi-workflow-bot · 2023-05-12T02:17:05Z

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

kazrael2119 · 2023-05-16T02:33:58Z

@us6193 ,you removed "NewApiVersionRequired" label, so I think you want to update this change in this exist api version, so I added "BreakingChangeReviewRequired" label

us6193 · 2023-05-17T00:27:54Z

@kazrael2119 I have got the change reviewed and approved can you please help merging the change. thanks

kazrael2119 · 2023-05-17T02:41:09Z

@kazrael2119 I have got the change reviewed and approved can you please help merging the change. thanks

I can't approve because Swagger BreakingChange is failed

us6193 · 2023-05-17T16:48:15Z

The swagger breaking change was failing saying there is a new property added compared to previous version for which we got the approval on, I have updated the tags accordingly and hopefully that should fix the issue. Can you help merge this asap as this is going to mark our services Red if this change is not merged sooner

raych1 · 2023-05-18T02:51:16Z

The swagger breaking change was failing saying there is a new property added compared to previous version for which we got the approval on, I have updated the tags accordingly and hopefully that should fix the issue. Can you help merge this asap as this is going to mark our services Red if this change is not merged sooner

@us6193 , this change is adding property to a released stable version which is breaking change and should be approved by breaking change review board. You cannot add approval label, neither does me.

us6193 · 2023-05-18T08:04:32Z

@raych1 Can you help me understand who needs to approve this then? As I already got approval from the review board

raych1 · 2023-05-18T08:25:38Z

@raych1 Can you help me understand who needs to approve this then? As I already got approval from the review board

Can you share me where's the approval from breaking change review board? Can you ask Jeffrey or Mike to approve in this PR?

us6193 · 2023-05-22T17:15:18Z

Got the change approved from breaking change approver:
https://msazure.visualstudio.com/One/_workitems/edit/23124358

Adding missing customerName property to fix S360 swagger correctness

899d1e6

us6193 requested review from wilcobmsft and asarkar84 as code owners May 12, 2023 01:16

openapi-assignment-bot bot assigned kazrael2119 May 12, 2023

openapi-workflow-bot bot added the FixS360 label May 12, 2023

ghost added the Billing label May 12, 2023

AzureRestAPISpecReview added NewApiVersionRequired resource-manager labels May 12, 2023

us6193 removed the NewApiVersionRequired label May 12, 2023

openapi-pipeline-app bot added the CI-BreakingChange-JavaScript label May 12, 2023

kazrael2119 added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label May 12, 2023

kazrael2119 added the Approved-SdkBreakingChange-JavaScript label May 12, 2023

wilcobmsft approved these changes May 17, 2023

View reviewed changes

us6193 added Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 and removed BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required labels May 17, 2023

raych1 added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required and removed Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 labels May 18, 2023

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

kazrael2119 approved these changes May 23, 2023

View reviewed changes

kazrael2119 added the Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates label May 23, 2023

tadelesh merged commit 52fe502 into Azure:main May 23, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding missing customerName property to fix S360 swagger correctness #23948

Adding missing customerName property to fix S360 swagger correctness #23948

us6193 commented May 12, 2023

openapi-workflow-bot bot commented May 12, 2023

openapi-pipeline-app bot commented May 12, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 12, 2023 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented May 12, 2023 •

edited

Loading

openapi-workflow-bot bot commented May 12, 2023

openapi-workflow-bot bot commented May 12, 2023

kazrael2119 commented May 16, 2023

us6193 commented May 17, 2023

kazrael2119 commented May 17, 2023

us6193 commented May 17, 2023

raych1 commented May 18, 2023

us6193 commented May 18, 2023

raych1 commented May 18, 2023

us6193 commented May 22, 2023

Adding missing customerName property to fix S360 swagger correctness #23948

Adding missing customerName property to fix S360 swagger correctness #23948

Conversation

us6193 commented May 12, 2023

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented May 12, 2023

openapi-pipeline-app bot commented May 12, 2023 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented May 12, 2023 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented May 12, 2023 • edited Loading

Generated ApiView

openapi-workflow-bot bot commented May 12, 2023

openapi-workflow-bot bot commented May 12, 2023

kazrael2119 commented May 16, 2023

us6193 commented May 17, 2023

kazrael2119 commented May 17, 2023

us6193 commented May 17, 2023

raych1 commented May 18, 2023

us6193 commented May 18, 2023

raych1 commented May 18, 2023

us6193 commented May 22, 2023

openapi-pipeline-app bot commented May 12, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 12, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 12, 2023 •

edited

Loading