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/2018-08-01-preview #20265

Conversation

vibsridh
Copy link
Contributor

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.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

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

ARM API Review Checklist

Applicability: ⚠️

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

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

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

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

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

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

Breaking Change Review Checklist

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

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

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

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

@openapi-workflow-bot
Copy link

Hi, @vibsridh 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. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 16, 2022

    Swagger Validation Report

    ️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.9.6)] new version base version
    costmanagement.insights.json 2020-08-01-preview(10d81ed) 2020-08-01-preview(main)
    Rule Message
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'value' renamed or removed?
    New: Microsoft.CostManagement/preview/2020-08-01-preview/costmanagement.insights.json#L83:7
    Old: Microsoft.CostManagement/preview/2020-08-01-preview/costmanagement.insights.json#L83:7
    1040 - AddedReadOnlyPropertyInResponse The new version has a new read-only property 'values' in response that was not found in the old version.
    New: Microsoft.CostManagement/preview/2020-08-01-preview/costmanagement.insights.json#L83:7
    Old: Microsoft.CostManagement/preview/2020-08-01-preview/costmanagement.insights.json#L83: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 v1.13.0) new version base version
    package-preview-2020-08 package-preview-2020-08(10d81ed) package-preview-2020-08(main)

    The following errors/warnings exist before current PR submission:

    Rule Message
    ⚠️ R1003 - ListInOperationName Since operation 'InsightsGet' response has model definition 'x-ms-pageable', it should be of the form 'list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.CostManagement/preview/2020-08-01-preview/costmanagement.insights.json#L41
    ⚠️ R2063 - OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'InsightsModel'. Consider using the plural form of 'Insights' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.CostManagement/preview/2020-08-01-preview/costmanagement.insights.json#L41
    ⚠️ R4014 - AllResourcesMustHaveGetOperation The resource 'Insights' does not have get operation, please add it.
    Location: Microsoft.CostManagement/preview/2020-08-01-preview/costmanagement.insights.json#L99
    ⚠️ R4024 - PreviewVersionOverOneYear The API version:2020-08-01-preview having been in a preview state over one year , please move it to GA or retire.
    Location: Microsoft.CostManagement/preview/2020-08-01-preview/costmanagement.insights.json#L4
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️❌~[Staging] ServiceAPIReadinessTest: 61 Errors, 0 Warnings failed [Detail] Service API Readiness Test failed. Check pipeline artifact for detail report.

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

    Rule Message
    RUNTIME_ERROR "statusCode: 404,
    errorCode: MissingSubscription,
    errorMessage: The request did not have a subscription or a valid tenant level resource provider."
    RUNTIME_ERROR "errorCode: AssertionError,
    errorMessage: expected response code to be 2XX but found 404"
    RUNTIME_ERROR "statusCode: 400,
    errorCode: InvalidView,
    errorMessage: Please provide a valid view ID.Unable to retrieve details for the specified view '/providers/Microsoft.CostManagement/views/swaggerExample'"
    RUNTIME_ERROR "errorCode: AssertionError,
    errorMessage: expected response code to be 2XX but found 400"
    OBJECT_ADDITIONAL_PROPERTIES "Additional properties not allowed: details"
    RUNTIME_ERROR "statusCode: 404,
    errorCode: MissingSubscription,
    errorMessage: The request did not have a subscription or a valid tenant level resource provider."
    RUNTIME_ERROR "errorCode: AssertionError,
    errorMessage: expected response code to be 2XX but found 404"
    RUNTIME_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The private scheduled action 'namedzzl3e' was not found."
    RUNTIME_ERROR "errorCode: AssertionError,
    errorMessage: expected response code to be 2XX but found 404"
    OBJECT_ADDITIONAL_PROPERTIES "Additional properties not allowed: details"
    RUNTIME_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The private scheduled action 'namedzzl3e' was not found."
    RUNTIME_ERROR "errorCode: AssertionError,
    errorMessage: expected response code to be 2XX but found 404"
    OBJECT_ADDITIONAL_PROPERTIES "Additional properties not allowed: details"
    RUNTIME_ERROR "statusCode: 404,
    errorCode: MissingSubscription,
    errorMessage: The request did not have a subscription or a valid tenant level resource provider."
    RUNTIME_ERROR "errorCode: AssertionError,
    errorMessage: expected response code to be 2XX but found 404"
    RUNTIME_ERROR "statusCode: 404,
    errorCode: MissingSubscription,
    errorMessage: The request did not have a subscription or a valid tenant level resource provider."
    RUNTIME_ERROR "errorCode: AssertionError,
    errorMessage: expected response code to be 2XX but found 404"
    RUNTIME_ERROR "statusCode: 404,
    errorCode: MissingSubscription,
    errorMessage: The request did not have a subscription or a valid tenant level resource provider."
    RUNTIME_ERROR "errorCode: AssertionError,
    errorMessage: expected response code to be 2XX but found 404"
    RUNTIME_ERROR "statusCode: 404,
    errorCode: MissingSubscription,
    errorMessage: The request did not have a subscription or a valid tenant level resource provider."
    RUNTIME_ERROR "errorCode: AssertionError,
    errorMessage: expected response code to be 2XX but found 404"
    RUNTIME_ERROR "statusCode: 404,
    errorCode: MissingSubscription,
    errorMessage: The request did not have a subscription or a valid tenant level resource provider."
    RUNTIME_ERROR "errorCode: AssertionError,
    errorMessage: expected response code to be 2XX but found 404"
    RUNTIME_ERROR "statusCode: 404,
    errorCode: MissingSubscription,
    errorMessage: The request did not have a subscription or a valid tenant level resource provider."
    RUNTIME_ERROR "errorCode: AssertionError,
    errorMessage: expected response code to be 2XX but found 404"
    ENUM_CASE_MISMATCH "Enum does not match case for: True"
    ENUM_CASE_MISMATCH "Enum does not match case for: True"
    RUNTIME_ERROR "statusCode: 401,
    errorCode: 401,
    errorMessage: Caller is not authorized"
    RUNTIME_ERROR "errorCode: AssertionError,
    errorMessage: expected response code to be 2XX but found 401"
    RUNTIME_ERROR "statusCode: 401,
    errorCode: 401,
    errorMessage: Caller is not authorized"
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️⚠️SDK Track2 Validation: 4 Warnings warning [Detail]
    • The following tags are being changed in this PR
      • "https://github.com/Azure/azure-rest-api-specs/blob/10d81ed31f0247879934b055c68b7e6153ba734f/specification/cost-management/resource-manager/readme.md#tag-package-preview-2020-08">cost-management/resource-manager/readme.md#package-preview-2020-08
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ Modeler/MissingType "readme":"cost-management/resource-manager/readme.md",
    "tag":"package-preview-2020-08",
    "details":"The schema 'AlertProperties-details-resourceGroupFilterItem' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#/components/schemas/AlertProperties-details-resourceGroupFilterItem"
    ⚠️ Modeler/MissingType "readme":"cost-management/resource-manager/readme.md",
    "tag":"package-preview-2020-08",
    "details":"The schema 'AlertProperties-details-resourceFilterItem' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#/components/schemas/AlertProperties-details-resourceFilterItem"
    ⚠️ Modeler/MissingType "readme":"cost-management/resource-manager/readme.md",
    "tag":"package-preview-2020-08",
    "details":"The schema 'AlertProperties-details-meterFilterItem' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#/components/schemas/AlertProperties-details-meterFilterItem"
    ⚠️ Modeler/MissingType "readme":"cost-management/resource-manager/readme.md",
    "tag":"package-preview-2020-08",
    "details":"The schema 'QueryProperties-rows-itemsItem' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#/components/schemas/QueryProperties-rows-itemsItem"


    The following errors/warnings exist before current PR submission:

    Rule Message
    ⚠️ UnkownSecurityScheme "readme":"cost-management/resource-manager/readme.md",
    "tag":"package-preview-2020-08",
    "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,
    AzureKey,
    Anonymous"
    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 16, 2022

    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 - armcostmanagement - 1.1.0
    azure-sdk-for-python-track2 - track2_azure-mgmt-costmanagement - Approved - 3.0.0
    ️❌ azure-sdk-for-net failed [Detail]
    • Failed [Logs]Release - Generate from 20b212e. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-6.0
      command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/cost-management/resource-manager/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] No usable version of the libssl was found
      cmderr	[Autorest] FATAL: csharp/simplifier - FAILED
      cmderr	[Autorest] FATAL: Error: [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
      cmderr	[Autorest] Process() cancelled due to exception : [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest
      warn	Skip package processing as generation is failed
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 20b212e. 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
    • ️✔️armcostmanagement [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New const `CostDetailsStatusTypeNoDataFoundCostDetailsStatusType`
      info	[Changelog] - New const `CostDetailsMetricTypeAmortizedCostCostDetailsMetricType`
      info	[Changelog] - New const `CostDetailsStatusTypeFailedCostDetailsStatusType`
      info	[Changelog] - New const `CostDetailsMetricTypeActualCostCostDetailsMetricType`
      info	[Changelog] - New const `CostDetailsDataFormatCSVCostDetailsDataFormat`
      info	[Changelog] - New const `CostDetailsStatusTypeCompletedCostDetailsStatusType`
      info	[Changelog] - New function `PossibleCostDetailsStatusTypeValues() []CostDetailsStatusType`
      info	[Changelog] - New function `NewGenerateCostDetailsReportClient(azcore.TokenCredential, *arm.ClientOptions) (*GenerateCostDetailsReportClient, error)`
      info	[Changelog] - New function `*GenerateCostDetailsReportClient.BeginCreateOperation(context.Context, string, GenerateCostDetailsReportRequestDefinition, *GenerateCostDetailsReportClientBeginCreateOperationOptions) (*runtime.Poller[GenerateCostDetailsReportClientCreateOperationResponse], error)`
      info	[Changelog] - New function `PossibleCostDetailsMetricTypeValues() []CostDetailsMetricType`
      info	[Changelog] - New function `PossibleCostDetailsDataFormatValues() []CostDetailsDataFormat`
      info	[Changelog] - New function `*GenerateCostDetailsReportClient.BeginGetOperationResults(context.Context, string, string, *GenerateCostDetailsReportClientBeginGetOperationResultsOptions) (*runtime.Poller[GenerateCostDetailsReportClientGetOperationResultsResponse], error)`
      info	[Changelog] - New struct `BlobInfo`
      info	[Changelog] - New struct `CostDetailsOperationResults`
      info	[Changelog] - New struct `CostDetailsTimePeriod`
      info	[Changelog] - New struct `GenerateCostDetailsReportClient`
      info	[Changelog] - New struct `GenerateCostDetailsReportClientBeginCreateOperationOptions`
      info	[Changelog] - New struct `GenerateCostDetailsReportClientBeginGetOperationResultsOptions`
      info	[Changelog] - New struct `GenerateCostDetailsReportClientCreateOperationResponse`
      info	[Changelog] - New struct `GenerateCostDetailsReportClientGetOperationResultsResponse`
      info	[Changelog] - New struct `GenerateCostDetailsReportErrorResponse`
      info	[Changelog] - New struct `GenerateCostDetailsReportRequestDefinition`
      info	[Changelog] - New struct `ReportManifest`
      info	[Changelog] - New struct `RequestContext`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 36 additive change(s).
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 20b212e. 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]  config global `--global`, `--local` are deprecated. Use `--location=global` instead.
    • ️✔️track2_azure-mgmt-costmanagement [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation group GenerateCostDetailsReportOperations
      info	[Changelog]   - Added operation group GenerateDetailedCostReportOperationResultsOperations
      info	[Changelog]   - Added operation group GenerateDetailedCostReportOperationStatusOperations
      info	[Changelog]   - Added operation group GenerateDetailedCostReportOperations
      info	[Changelog]   - Model Alert has a new parameter e_tag
      info	[Changelog]   - Model AlertPropertiesDetails has a new parameter company_name
      info	[Changelog]   - Model AlertPropertiesDetails has a new parameter department_name
      info	[Changelog]   - Model AlertPropertiesDetails has a new parameter enrollment_end_date
      info	[Changelog]   - Model AlertPropertiesDetails has a new parameter enrollment_number
      info	[Changelog]   - Model AlertPropertiesDetails has a new parameter enrollment_start_date
      info	[Changelog]   - Model AlertPropertiesDetails has a new parameter invoicing_threshold
      info	[Changelog]   - Model CommonExportProperties has a new parameter next_run_time_estimate
      info	[Changelog]   - Model CommonExportProperties has a new parameter partition_data
      info	[Changelog]   - Model CommonExportProperties has a new parameter run_history
      info	[Changelog]   - Model Dimension has a new parameter e_tag
      info	[Changelog]   - Model Dimension has a new parameter location
      info	[Changelog]   - Model Dimension has a new parameter sku
      info	[Changelog]   - Model Export has a new parameter next_run_time_estimate
      info	[Changelog]   - Model Export has a new parameter partition_data
      info	[Changelog]   - Model Export has a new parameter run_history
      info	[Changelog]   - Model ExportDeliveryDestination has a new parameter sas_token
      info	[Changelog]   - Model ExportDeliveryDestination has a new parameter storage_account
      info	[Changelog]   - Model ExportExecution has a new parameter e_tag
      info	[Changelog]   - Model ExportExecution has a new parameter error
      info	[Changelog]   - Model ExportProperties has a new parameter next_run_time_estimate
      info	[Changelog]   - Model ExportProperties has a new parameter partition_data
      info	[Changelog]   - Model ExportProperties has a new parameter run_history
      info	[Changelog]   - Model Operation has a new parameter id
      info	[Changelog]   - Model OperationDisplay has a new parameter description
      info	[Changelog]   - Model Resource has a new parameter e_tag
      info	[Changelog]   - Model Resource has a new parameter location
      info	[Changelog]   - Model Resource has a new parameter sku
      info	[Changelog]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog]   - Model Alert no longer has parameter tags
      info	[Changelog]   - Model ExportExecution no longer has parameter tags
      info	[Changelog]   - Model ReportConfigFilter no longer has parameter tag_key
      info	[Changelog]   - Model ReportConfigFilter no longer has parameter tag_value
      info	[Changelog]   - Operation ExportsOperations.get has a new parameter expand
      info	[Changelog]   - Operation ExportsOperations.list has a new parameter expand
      info	[Changelog]   - Removed operation group SettingsOperations
    ️❌ azure-resource-manager-schemas failed [Detail]
    • Failed [Logs]Release - Generate from 20b212e. 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
    • cost-management/resource-manager [View full logs
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 20b212e. 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.Cost [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 16, 2022

    Generated ApiView

    Language Package Name ApiView Link
    Python track2_azure-mgmt-costmanagement Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

    @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 @vibsridh, 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.

    @msyyc
    Copy link
    Member

    msyyc commented Aug 17, 2022

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @msyyc
    Copy link
    Member

    msyyc commented Aug 17, 2022

    image
    The swagger breaking change is for bugfix which is reasonable. add @JeffreyRichter to confirm.

    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-SdkBreakingChange-Python resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants