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

Revert "2022-06-01 version for pricesheets and operations API " #22780

Conversation

mehulviby
Copy link
Contributor

Reverts #22240

@mehulviby mehulviby requested a review from kjeur as a code owner February 23, 2023 21:31
@openapi-workflow-bot
Copy link

Hi, @mehulviby 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 Feb 23, 2023

    Swagger Validation Report

    ️❌BreakingChange: 6 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    consumption.pricesheets.operations.json 2022-06-01(574ca5a) 2022-06-01(main)
    Rule Message
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/pricesheets/default' removed or restructured?
    Old: Microsoft.Consumption/stable/2022-06-01/consumption.pricesheets.operations.json#L37:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/pricesheets/default' removed or restructured?
    Old: Microsoft.Consumption/stable/2022-06-01/consumption.pricesheets.operations.json#L100:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.Consumption/operations' removed or restructured?
    Old: Microsoft.Consumption/stable/2022-06-01/consumption.pricesheets.operations.json#L169:5
    1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'subscriptionIdParameter' removed or renamed?
    New: Microsoft.Consumption/stable/2022-06-01/consumption.pricesheets.operations.json#L38:3
    Old: Microsoft.Consumption/stable/2022-06-01/consumption.pricesheets.operations.json#L484:3
    1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'apiVersionParameter' removed or renamed?
    New: Microsoft.Consumption/stable/2022-06-01/consumption.pricesheets.operations.json#L38:3
    Old: Microsoft.Consumption/stable/2022-06-01/consumption.pricesheets.operations.json#L484:3
    1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'billingPeriodNameParameter' removed or renamed?
    New: Microsoft.Consumption/stable/2022-06-01/consumption.pricesheets.operations.json#L38:3
    Old: Microsoft.Consumption/stable/2022-06-01/consumption.pricesheets.operations.json#L484:3
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.
    compared tags (via openapi-validator v2.0.0) new version base version
    default default(574ca5a) default(main)
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
    Validation passes for ServiceAPIReadinessTest.
    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 23, 2023

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
    ️❌SDK Breaking Change Tracking failed [Detail]

    Breaking Changes Tracking

    azure-sdk-for-go - sdk/resourcemanager/consumption/armconsumption - 2.0.0
    +	Field `Etag` of struct `CreditSummary` has been removed
    +	Field `MarketplaceCharges` of struct `LegacyChargeSummaryProperties` has been removed
    +	Field `Tags` of struct `CreditSummary` has been removed
    +	Type of `ModernReservationRecommendation.Properties` has been changed from `*ModernReservationRecommendationProperties` to `ModernReservationRecommendationPropertiesClassification`
    azure-sdk-for-python-track2 - track2_azure-mgmt-consumption - 11.0.0b1
    +	Model CreditSummary no longer has parameter etag
    +	Model CreditSummary no longer has parameter tags
    +	Model LegacyChargeSummary no longer has parameter marketplace_charges
    +	Parameter scope of model ModernReservationRecommendation is now required
    azure-sdk-for-js - @azure/arm-consumption - 10.0.0
    +	Interface BudgetFilter no longer has parameter not
    +	Interface LegacyChargeSummary no longer has parameter marketplaceCharges
    +	Operation ReservationRecommendationDetails.get has a new signature
    +	Parameter scope of interface ModernReservationRecommendation is now required
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 82823cd. 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/consumption/armconsumption [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Type of `ModernReservationRecommendation.Properties` has been changed from `*ModernReservationRecommendationProperties` to `ModernReservationRecommendationPropertiesClassification`
      info	[Changelog] - Field `Etag` of struct `CreditSummary` has been removed
      info	[Changelog] - Field `Tags` of struct `CreditSummary` has been removed
      info	[Changelog] - Field `MarketplaceCharges` of struct `LegacyChargeSummaryProperties` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New value `EventTypeCreditExpired` added to type alias `EventType`
      info	[Changelog] - New function `*ModernReservationRecommendationProperties.GetModernReservationRecommendationProperties() *ModernReservationRecommendationProperties`
      info	[Changelog] - New function `*ModernSharedScopeReservationRecommendationProperties.GetModernReservationRecommendationProperties() *ModernReservationRecommendationProperties`
      info	[Changelog] - New function `*ModernSingleScopeReservationRecommendationProperties.GetModernReservationRecommendationProperties() *ModernReservationRecommendationProperties`
      info	[Changelog] - New struct `ModernSharedScopeReservationRecommendationProperties`
      info	[Changelog] - New struct `ModernSingleScopeReservationRecommendationProperties`
      info	[Changelog] - New field `ETag` in struct `CreditSummary`
      info	[Changelog] - New field `AzureMarketplaceCharges` in struct `LegacyChargeSummaryProperties`
      info	[Changelog] - New field `SubscriptionID` in struct `ModernChargeSummaryProperties`
      info	[Changelog]
      info	[Changelog] Total 3 breaking change(s), 12 additive change(s).
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 82823cd. 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]  notice
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.3.1 -> 9.5.1
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.5.1>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.5.1` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-consumption [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Model CreditSummary has a new parameter e_tag_properties_e_tag
      info	[Changelog]   - Model LegacyChargeSummary has a new parameter azure_marketplace_charges
      info	[Changelog]   - Model ModernChargeSummary has a new parameter subscription_id
      info	[Changelog]   - Model ModernReservationRecommendation has a new parameter resource_type
      info	[Changelog]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog]   - Model CreditSummary no longer has parameter etag
      info	[Changelog]   - Model CreditSummary no longer has parameter tags
      info	[Changelog]   - Model LegacyChargeSummary no longer has parameter marketplace_charges
      info	[Changelog]   - Parameter scope of model ModernReservationRecommendation is now required
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 82823cd. 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 -> 23.0.1
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      cmderr	[init.sh] [notice] A new release of pip is available: 23.0 -> 23.0.1
      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
      cmderr	[generate.py] [ForkJoinPool-1-worker-3] INFO com.azure.core.test.implementation.TestingHelpers - Environment variable 'AZURE_TEST_MODE' has not been set yet. Using 'Playback' mode.
    • ️✔️azure-resourcemanager-consumption [View full logs]  [Release SDK Changes]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 82823cd. 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-consumption [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation LotsOperations.listByCustomer
      info	[Changelog]   - Added Interface LotsListByCustomerNextOptionalParams
      info	[Changelog]   - Added Interface LotsListByCustomerOptionalParams
      info	[Changelog]   - Added Interface ModernReservationRecommendationProperties
      info	[Changelog]   - Added Interface ModernSharedScopeReservationRecommendationProperties
      info	[Changelog]   - Added Interface ModernSingleScopeReservationRecommendationProperties
      info	[Changelog]   - Added Type Alias LotsListByCustomerNextResponse
      info	[Changelog]   - Added Type Alias LotsListByCustomerResponse
      info	[Changelog]   - Added Type Alias ModernReservationRecommendationPropertiesUnion
      info	[Changelog]   - Interface CreditSummary has a new optional parameter eTagPropertiesETag
      info	[Changelog]   - Interface LegacyChargeSummary has a new optional parameter azureMarketplaceCharges
      info	[Changelog]   - Interface LegacyUsageDetail has a new optional parameter benefitId
      info	[Changelog]   - Interface LegacyUsageDetail has a new optional parameter benefitName
      info	[Changelog]   - Interface ModernChargeSummary has a new optional parameter subscriptionId
      info	[Changelog]   - Interface ModernReservationRecommendation has a new optional parameter resourceType
      info	[Changelog]   - Enum KnownEventType has a new value CreditExpired
      info	[Changelog]
      info	[Changelog] **Breaking Changes**
      info	[Changelog]
      info	[Changelog]   - Operation ReservationRecommendationDetails.get has a new signature
      info	[Changelog]   - Interface BudgetFilter no longer has parameter not
      info	[Changelog]   - Interface LegacyChargeSummary no longer has parameter marketplaceCharges
      info	[Changelog]   - Parameter scope of interface ModernReservationRecommendation is now required
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 82823cd. 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
    • ️✔️consumption [View full logs
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 82823cd. 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.Consumption [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 Feb 23, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/consumption/armconsumption https://apiview.dev/Assemblies/Review/272e656eb403449cb50dd0b8619ba386
    Java azure-resourcemanager-consumption https://apiview.dev/Assemblies/Review/acc48df74f3c41f291f3e05db67ff078
    .Net Azure.ResourceManager.Consumption There is no API change compared with the previous version
    JavaScript @azure/arm-consumption https://apiview.dev/Assemblies/Review/b50745e910fa4749911dc397774530ac

    @AzureRestAPISpecReview AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required resource-manager labels Feb 23, 2023
    @openapi-workflow-bot
    Copy link

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

    @ArcturusZhang
    Copy link
    Member

    No SDK release requests have been filed since the target PR was merged. Skip breaking change review process for this case.

    tombuildsstuff added a commit to hashicorp/pandora that referenced this pull request Feb 27, 2023
    @tombuildsstuff
    Copy link
    Contributor

    tombuildsstuff commented Feb 27, 2023

    @ArcturusZhang @mehulviby could you provide a little context on why this 8 month old Stable API version is being removed?

    Our automated tooling detected this new API Version and has auto-imported it which means that we have generated a Go SDK from it.

    Whilst we aren't using this API Version right now, we're looking towards being able to auto-update the API Versions used in the future, and so I'm curious as to why this got removed without a proper deprecation period? My understanding is that once a Swagger file is present within the main branch of this repository it's safe to consume - and that Stable API Versions should go through a full deprecation period of (if memory serves) 3 years.

    Whilst SDK / Service Versions appear to be listed within the Azure SDK Release Requests repository, it's not public - so the only means we have of knowing that an API Version is available for use is that the associated API Definitions are present within the main branch of this repository (which has been the case since #22240 got merged 2 weeks ago in #22240 (comment)).

    Thanks!

    aviyerMSFT pushed a commit to aviyerMSFT/azure-rest-api-specs that referenced this pull request Mar 22, 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 BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-BreakingChange-Go CI-BreakingChange-JavaScript resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants