Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

[Hub Generated] Review request for Microsoft.CostManagement to add version preview/2023-04-01-preview #23883

Conversation

ankur-ms
Copy link
Contributor

@ankur-ms ankur-ms commented May 9, 2023

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

ARM API Information (Control Plane)

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

Changelog

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

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

Contribution checklist (MS Employees Only):

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

ARM API Review Checklist

Applicability: ⚠️

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

  • Change to data plane APIs
  • Adding new properties
  • All removals

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

  • [] Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
  • Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

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

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

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

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

@openapi-workflow-bot
Copy link

Hi, @ankur-ms Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 9, 2023

    Swagger Validation Report

    ️❌BreakingChange: 4 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    costmanagement.exports.json 2023-04-01-preview(d201f19) 2023-04-01-preview(main)
    Rule Message
    1041 - AddedPropertyInResponse The new version has a new property 'identity' in response that was not found in the old version.
    New: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L418:7
    Old: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L418:7
    1041 - AddedPropertyInResponse The new version has a new property 'location' in response that was not found in the old version.
    New: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L418:7
    Old: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L418:7
    1045 - AddedOptionalProperty The new version has a new optional property 'identity' that was not found in the old version.
    New: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L418:7
    Old: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L418:7
    1045 - AddedOptionalProperty The new version has a new optional property 'location' that was not found in the old version.
    New: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L418:7
    Old: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L418: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.2) new version base version
    package-preview-2023-04 package-preview-2023-04(d201f19) package-preview-2023-04(main)

    The following errors/warnings exist before current PR submission:

    Rule Message
    NoDuplicatePathsForScopeParameter Path '/{scope}/providers/Microsoft.CostManagement/exports/{exportName}' with explicitly defined scope is a duplicate of path '/{scope}/providers/Microsoft.CostManagement/exports' that has the scope parameter.'.
    Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L36
    NoDuplicatePathsForScopeParameter Path '/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/run' with explicitly defined scope is a duplicate of path '/{scope}/providers/Microsoft.CostManagement/exports' that has the scope parameter.'.
    Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L36
    NoDuplicatePathsForScopeParameter Path '/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory' with explicitly defined scope is a duplicate of path '/{scope}/providers/Microsoft.CostManagement/exports' that has the scope parameter.'.
    Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L36
    GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
    Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L84
    NoDuplicatePathsForScopeParameter Path '/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/run' with explicitly defined scope is a duplicate of path '/{scope}/providers/Microsoft.CostManagement/exports/{exportName}' that has the scope parameter.'.
    Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L97
    NoDuplicatePathsForScopeParameter Path '/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory' with explicitly defined scope is a duplicate of path '/{scope}/providers/Microsoft.CostManagement/exports/{exportName}' that has the scope parameter.'.
    Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L97
    ResourceNameRestriction The resource name parameter 'exportName' should be defined with a 'pattern' restriction.
    Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L97
    ParametersInPointGet Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version.
    Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L127
    PutResponseSchemaDescription Description of 200 response code of a PUT operation MUST include term 'update'.
    Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L209
    DeleteOperationResponses The delete operation is defined without a 200 or 204 error response implementation,please add it.'
    Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L270
    NoDuplicatePathsForScopeParameter Path '/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory' with explicitly defined scope is a duplicate of path '/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/run' that has the scope parameter.'.
    Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L283
    ResourceNameRestriction The resource name parameter 'exportName' should be defined with a 'pattern' restriction.
    Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L283
    SyncPostReturn 200 response for a synchronous POST operation must have a response schema specified.
    Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L284
    ResourceNameRestriction The resource name parameter 'exportName' should be defined with a 'pattern' restriction.
    Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L337
    GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
    Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L381
    TopLevelResourcesListBySubscription The top-level resource 'Export' does not have list by subscription operation, please add it.
    Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L410
    ⚠️ PageableOperation Based on the response model schema, operation 'Exports_List' might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L37
    ⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'scope'.
    Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L66
    ⚠️ RequiredReadOnlySystemData The response of operation:'Exports_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L98
    ⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'scope'.
    Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L127
    ⚠️ RequiredReadOnlySystemData The response of operation:'Exports_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L160
    ⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'scope'.
    Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L189
    ⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'scope'.
    Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L259
    ⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'run' in:'Exports_Execute'. Consider updating the operationId
    Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L288
    ⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'scope'.
    Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L313
    ⚠️ ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
    Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L338
    ⚠️ PageableOperation Based on the response model schema, operation 'Exports_GetExecutionHistory' might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L338
    ⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'scope'.
    Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json#L367
    ️️✔️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]
    ️️✔️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
    Copy link

    openapi-pipeline-app bot commented May 9, 2023

    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/costmanagement/armcostmanagement - Approved - 2.0.0
    +	Enum `ForecastTimeframeType` has been removed
    +	Enum `ReportConfigColumnType` has been removed
    +	Field `ETag` of struct `ProxyResource` has been removed
    +	Field `ETag`, `Location`, `SKU`, `Tags` of struct `Resource` has been removed
    +	Field `ID` of struct `Operation` has been removed
    +	Field `QueryResult` of struct `ForecastClientExternalCloudProviderUsageResponse` has been removed
    +	Field `QueryResult` of struct `ForecastClientUsageResponse` has been removed
    +	Operation `*GenerateDetailedCostReportOperationResultsClient.Get` has been changed to LRO, use `*GenerateDetailedCostReportOperationResultsClient.BeginGet` instead.
    +	Struct `ExportExecutionProperties` has been removed
    +	Struct `ExportExecution` has been removed
    +	Type of `ExportExecutionListResult.Value` has been changed from `[]*ExportExecution` to `[]*ExportRun`
    +	Type of `ForecastDataset.Aggregation` has been changed from `map[string]*QueryAggregation` to `map[string]*ForecastAggregation`
    +	Type of `ForecastDataset.Configuration` has been changed from `*QueryDatasetConfiguration` to `*ForecastDatasetConfiguration`
    +	Type of `ForecastDataset.Filter` has been changed from `*QueryFilter` to `*ForecastFilter`
    +	Type of `ForecastDefinition.TimePeriod` has been changed from `*QueryTimePeriod` to `*ForecastTimePeriod`
    +	Type of `ForecastDefinition.Timeframe` has been changed from `*ForecastTimeframeType` to `*ForecastTimeframe`
    +	Type of `OperationListResult.Value` has been changed from `[]*Operation` to `[]*OperationForCostManagement`
    +	Type of `ReportConfigGrouping.Type` has been changed from `*ReportConfigColumnType` to `*QueryColumnType`
    +	`QueryColumnTypeTag` from enum `QueryColumnType` has been removed
    azure-sdk-for-python-track2 - track2_azure-mgmt-costmanagement - Approved - 3.0.0
    +	Model Alert no longer has parameter tags
    +	Model ProxyResource no longer has parameter e_tag
    +	Model ReportConfigFilter no longer has parameter tag_key
    +	Model ReportConfigFilter no longer has parameter tag_value
    +	Model Resource no longer has parameter tags
    +	Removed operation group SettingsOperations
    ️❌ azure-sdk-for-net-track2 failed [Detail]
    • Failed [Logs]Release - Generate from 40fd627. 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:712
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 712 | �[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:800
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 800 | �[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:712
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 712 | �[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.Cost-Management [View full logs]  [Release SDK Changes]
      info	[Changelog]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 40fd627. 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/costmanagement/armcostmanagement [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New value `OperationStatusTypeComplete` added to enum type `OperationStatusType`
      info	[Changelog] - New enum type `BenefitUtilizationSummaryReportSchema` with values `BenefitUtilizationSummaryReportSchemaAvgUtilizationPercentage`, `BenefitUtilizationSummaryReportSchemaBenefitID`, `BenefitUtilizationSummaryReportSchemaBenefitOrderID`, `BenefitUtilizationSummaryReportSchemaBenefitType`, `BenefitUtilizationSummaryReportSchemaKind`, `BenefitUtilizationSummaryReportSchemaMaxUtilizationPercentage`, `BenefitUtilizationSummaryReportSchemaMinUtilizationPercentage`, `BenefitUtilizationSummaryReportSchemaUsageDate`, `BenefitUtilizationSummaryReportSchemaUtilizedPercentage`
      info	[Changelog] - New function `NewBillingAccountScopeClient(azcore.TokenCredential, *arm.ClientOptions) (*BillingAccountScopeClient, error)`
      info	[Changelog] - New function `*BillingAccountScopeClient.BeginGenerateBenefitUtilizationSummariesReport(context.Context, string, BenefitUtilizationSummariesRequest, *BillingAccountScopeClientBeginGenerateBenefitUtilizationSummariesReportOptions) (*runtime.Poller[BillingAccountScopeClientGenerateBenefitUtilizationSummariesReportResponse], error)`
      info	[Changelog] - New function `NewBillingProfileScopeClient(azcore.TokenCredential, *arm.ClientOptions) (*BillingProfileScopeClient, error)`
      info	[Changelog] - New function `*BillingProfileScopeClient.BeginGenerateBenefitUtilizationSummariesReport(context.Context, string, string, BenefitUtilizationSummariesRequest, *BillingProfileScopeClientBeginGenerateBenefitUtilizationSummariesReportOptions) (*runtime.Poller[BillingProfileScopeClientGenerateBenefitUtilizationSummariesReportResponse], error)`
      info	[Changelog] - New function `*ClientFactory.NewBillingAccountScopeClient() *BillingAccountScopeClient`
      info	[Changelog] - New function `*ClientFactory.NewBillingProfileScopeClient() *BillingProfileScopeClient`
      info	[Changelog] - New function `*ClientFactory.NewReservationOrderScopeClient() *ReservationOrderScopeClient`
      info	[Changelog] - New function `*ClientFactory.NewReservationScopeClient() *ReservationScopeClient`
      info	[Changelog] - New function `*ClientFactory.NewSavingsPlanOrderScopeClient() *SavingsPlanOrderScopeClient`
      info	[Changelog] - New function `*ClientFactory.NewSavingsPlanScopeClient() *SavingsPlanScopeClient`
      info	[Changelog] - New function `NewReservationOrderScopeClient(azcore.TokenCredential, *arm.ClientOptions) (*ReservationOrderScopeClient, error)`
      info	[Changelog] - New function `*ReservationOrderScopeClient.BeginGenerateBenefitUtilizationSummariesReport(context.Context, string, BenefitUtilizationSummariesRequest, *ReservationOrderScopeClientBeginGenerateBenefitUtilizationSummariesReportOptions) (*runtime.Poller[ReservationOrderScopeClientGenerateBenefitUtilizationSummariesReportResponse], error)`
      info	[Changelog] - New function `NewReservationScopeClient(azcore.TokenCredential, *arm.ClientOptions) (*ReservationScopeClient, error)`
      info	[Changelog] - New function `*ReservationScopeClient.BeginGenerateBenefitUtilizationSummariesReport(context.Context, string, string, BenefitUtilizationSummariesRequest, *ReservationScopeClientBeginGenerateBenefitUtilizationSummariesReportOptions) (*runtime.Poller[ReservationScopeClientGenerateBenefitUtilizationSummariesReportResponse], error)`
      info	[Changelog] - New function `NewSavingsPlanOrderScopeClient(azcore.TokenCredential, *arm.ClientOptions) (*SavingsPlanOrderScopeClient, error)`
      info	[Changelog] - New function `*SavingsPlanOrderScopeClient.BeginGenerateBenefitUtilizationSummariesReport(context.Context, string, BenefitUtilizationSummariesRequest, *SavingsPlanOrderScopeClientBeginGenerateBenefitUtilizationSummariesReportOptions) (*runtime.Poller[SavingsPlanOrderScopeClientGenerateBenefitUtilizationSummariesReportResponse], error)`
      info	[Changelog] - New function `NewSavingsPlanScopeClient(azcore.TokenCredential, *arm.ClientOptions) (*SavingsPlanScopeClient, error)`
      info	[Changelog] - New function `*SavingsPlanScopeClient.BeginGenerateBenefitUtilizationSummariesReportAsync(context.Context, string, string, BenefitUtilizationSummariesRequest, *SavingsPlanScopeClientBeginGenerateBenefitUtilizationSummariesReportAsyncOptions) (*runtime.Poller[SavingsPlanScopeClientGenerateBenefitUtilizationSummariesReportAsyncResponse], error)`
      info	[Changelog] - New struct `AsyncOperationStatusProperties`
      info	[Changelog] - New struct `BenefitUtilizationSummariesOperationStatus`
      info	[Changelog] - New struct `BenefitUtilizationSummariesRequest`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 35 additive change(s).
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 40fd627. 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] E: Unable to locate package python3.10-venv
      cmderr	[automation_init.sh] E: Couldn't find any package by glob 'python3.10-venv'
      cmderr	[automation_init.sh] E: Couldn't find any package by regex 'python3.10-venv'
      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] notice
      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-costmanagement [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation group BillingAccountScopeOperations
      info	[Changelog]   - Added operation group BillingProfileScopeOperations
      info	[Changelog]   - Added operation group ReservationOrderScopeOperations
      info	[Changelog]   - Added operation group ReservationScopeOperations
      info	[Changelog]   - Added operation group SavingsPlanOrderScopeOperations
      info	[Changelog]   - Added operation group SavingsPlanScopeOperations
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 40fd627. 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]  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
    • ️✔️cost-management [View full logs]  [Release Schema Changes]
    ️❌ azure-powershell failed [Detail]
    • Pipeline Framework Failed [Logs]Release - Generate from 40fd627. 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.cost-management.DefaultTag [View full logs
      error	Fatal error: SSL error: syscall failure: Broken pipe
      error	The following packages are still pending:
      error		Az.cost-management.DefaultTag
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 9, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/costmanagement/armcostmanagement https://apiview.dev/Assemblies/Review/055f0f496993467dab15c23f4b11819a

    @openapi-workflow-bot
    Copy link

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

    Hi @ankur-ms, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval.

    @openapi-workflow-bot
    Copy link

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

    @raosuhas
    Copy link

    @ankur-ms please add the previous version as the base commit as explained here :
    image

    @raosuhas raosuhas added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label May 15, 2023
    @openapi-workflow-bot
    Copy link

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

    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 15, 2023
    @ankur-ms
    Copy link
    Contributor Author

    @ankur-ms please add the previous version as the base commit as explained here : image

    Hi @raosuhas, this PR is replica of PR in private repo https://github.com/Azure/azure-rest-api-specs-pr/pull/11452. We got the sign off during this private preview. Now we are moving with publishing swagger for public preview.

    @ankur-ms ankur-ms closed this May 18, 2023
    @ankur-ms ankur-ms reopened this May 18, 2023
    @ankur-ms ankur-ms removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label May 19, 2023
    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 19, 2023
    @raosuhas
    Copy link

    Updating an existing api version is considered a breaking change

    @ankur-ms ankur-ms removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label May 22, 2023
    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 22, 2023
    @ankur-ms ankur-ms requested a review from raosuhas May 22, 2023 14:32
    @visingla-ms visingla-ms added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label May 22, 2023
    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 22, 2023
    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label May 24, 2023
    @ankur-ms ankur-ms removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label May 24, 2023
    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 24, 2023
    @visingla-ms visingla-ms added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label May 24, 2023
    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 24, 2023
    @ankur-ms ankur-ms removed the request for review from raosuhas May 25, 2023 04:00
    @ankur-ms ankur-ms assigned visingla-ms and unassigned visingla-ms May 25, 2023
    @ankhyk
    Copy link
    Contributor

    ankhyk commented May 26, 2023

    @raych1 @msyyc please help take a look at GO and Python SDK breaking change

    @raych1 raych1 added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label May 31, 2023
    @ankhyk ankhyk added the Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates label May 31, 2023
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go Approved-SdkBreakingChange-Python ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go NewApiVersionRequired resource-manager SuppressionReviewRequired
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    9 participants