Skip to content

Single directives#23014

Merged
thramu merged 1 commit intodev-consumption-Microsoft.Consumption-2023-03-01from
matteberhart/fixSdkFailures
Mar 13, 2023
Merged

Single directives#23014
thramu merged 1 commit intodev-consumption-Microsoft.Consumption-2023-03-01from
matteberhart/fixSdkFailures

Conversation

@MattEberhart-MSFTE
Copy link
Contributor

@MattEberhart-MSFTE MattEberhart-MSFTE commented Mar 10, 2023

ARM API Information (Control Plane)

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

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

Changelog

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

  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, @MattEberhart-MSFTE 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 Mar 10, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.
    compared tags (via openapi-validator v2.0.0) new version base version
    default default(d7bfbca) default(dev-consumption-Microsoft.Consumption-2023-03-01)
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️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 Mar 10, 2023

    Swagger Generation Artifacts

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

    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 failed [Detail]
    • Failed [Logs] Generate from d1f46ce0c204057ae3dd9dec7a67622d559c3512. 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:672
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 672 | �[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 build sdk. exit code: False
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
    • Azure.ResourceManager.Consumption [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] Breaking Changes: /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(96,5): error : ApiCompat failed for '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/bin/Azure.ResourceManager.Consumption/Debug/netstandard2.0/Azure.ResourceManager.Consumption.dll' [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/consumption/Azure.ResourceManager.Consumption/src/Azure.ResourceManager.Consumption.csproj::TargetFramework=netstandard2.0]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from d1f46ce0c204057ae3dd9dec7a67622d559c3512. 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]  [Preview 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 `IsEstimatedBalance` in struct `CreditSummaryProperties`
      info	[Changelog] - New field `IsEstimatedBalance` in struct `EventProperties`
      info	[Changelog] - New field `AzureMarketplaceCharges` in struct `LegacyChargeSummaryProperties`
      info	[Changelog] - New field `IsEstimatedBalance` in struct `LotProperties`
      info	[Changelog] - New field `SubscriptionID` in struct `ModernChargeSummaryProperties`
      info	[Changelog] - New field `PreviewMarkupPercentage` in struct `ReservationTransactionsClientListOptions`
      info	[Changelog] - New field `UseMarkupIfPartner` in struct `ReservationTransactionsClientListOptions`
      info	[Changelog]
      info	[Changelog] Total 3 breaking change(s), 16 additive change(s).
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from d1f46ce0c204057ae3dd9dec7a67622d559c3512. 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 major version of npm available! 8.19.3 -> 9.6.1
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.1>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.6.1` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-consumption [View full logs]  [Preview 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 CreditSummary has a new parameter is_estimated_balance
      info	[Changelog]   - Model EventSummary has a new parameter is_estimated_balance
      info	[Changelog]   - Model LegacyChargeSummary has a new parameter azure_marketplace_charges
      info	[Changelog]   - Model LotSummary has a new parameter is_estimated_balance
      info	[Changelog]   - Model ModernChargeSummary has a new parameter subscription_id
      info	[Changelog]   - Model ModernReservationRecommendation has a new parameter resource_type
      info	[Changelog]   - Operation ReservationTransactionsOperations.list has a new optional parameter preview_markup_percentage
      info	[Changelog]   - Operation ReservationTransactionsOperations.list has a new optional parameter use_markup_if_partner
      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]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from d1f46ce0c204057ae3dd9dec7a67622d559c3512. 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]  [Preview 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 CreditSummary has a new optional parameter isEstimatedBalance
      info	[Changelog]   - Interface EventSummary has a new optional parameter isEstimatedBalance
      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 LotSummary has a new optional parameter isEstimatedBalance
      info	[Changelog]   - Interface ModernChargeSummary has a new optional parameter subscriptionId
      info	[Changelog]   - Interface ModernReservationRecommendation has a new optional parameter resourceType
      info	[Changelog]   - Interface ReservationTransactionsListOptionalParams has a new optional parameter previewMarkupPercentage
      info	[Changelog]   - Interface ReservationTransactionsListOptionalParams has a new optional parameter useMarkupIfPartner
      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] Generate from d1f46ce0c204057ae3dd9dec7a67622d559c3512. 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
    • ️✔️consumption [View full logs]  [Preview Schema Changes]
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from d1f46ce0c204057ae3dd9dec7a67622d559c3512. 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]  [Preview SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 10, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/consumption/armconsumption https://apiview.dev/Assemblies/Review/28c90e2ecbd447f6a24a6b718d357f38
    .Net Azure.ResourceManager.Consumption https://apiview.dev/Assemblies/Review/4a61348a4981481a873567e8ce596d08
    JavaScript @azure/arm-consumption https://apiview.dev/Assemblies/Review/b4537bae74614ae19e55b58cf5f2963a
    Java azure-resourcemanager-consumption https://apiview.dev/Assemblies/Review/78560ed73cb64ad39a1a13d32a1cf105

    @openapi-workflow-bot
    Copy link

    Hi @MattEberhart-MSFTE, 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 @MattEberhart-MSFTE, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @openapi-workflow-bot
    Copy link

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

    @MattEberhart-MSFTE MattEberhart-MSFTE force-pushed the matteberhart/fixSdkFailures branch from 4618233 to d7bfbca Compare March 10, 2023 19:19
    @AzureRestAPISpecReview AzureRestAPISpecReview removed the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Mar 10, 2023
    @thramu thramu self-assigned this Mar 13, 2023
    @thramu thramu merged commit 410617a into dev-consumption-Microsoft.Consumption-2023-03-01 Mar 13, 2023
    @thramu thramu deleted the matteberhart/fixSdkFailures branch March 13, 2023 17:18
    thramu pushed a commit that referenced this pull request Mar 23, 2023
    MattEberhart-MSFTE added a commit that referenced this pull request Mar 23, 2023
    thramu pushed a commit that referenced this pull request Mar 23, 2023
    raych1 pushed a commit that referenced this pull request Mar 24, 2023
    …on stable/2023-03-01 (#23264)
    
    * Adds base for updating Microsoft.Consumption from version stable/2022-09-01 to version 2023-03-01
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * Adding new API version contract changes to 2023-03-01 (#22644)
    
    * Added RI Tranastions query parameters to billing account scope. Updat… (#22963)
    
    * Added RI Tranastions query parameters to billing account scope. Updated example. Added documentation around size response limit
    
    * Ran prettify and fixed typo
    
    * Adding suppression for valid formats
    
    * Single directives (#23014)
    
    ---------
    
    Co-authored-by: MattEberhart-MSFTE <107518095+MattEberhart-MSFTE@users.noreply.github.com>
    JoshLove-msft pushed a commit to JoshLove-msft/azure-rest-api-specs that referenced this pull request Apr 25, 2023
    …on stable/2023-03-01 (Azure#23264)
    
    * Adds base for updating Microsoft.Consumption from version stable/2022-09-01 to version 2023-03-01
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * Adding new API version contract changes to 2023-03-01 (Azure#22644)
    
    * Added RI Tranastions query parameters to billing account scope. Updat… (Azure#22963)
    
    * Added RI Tranastions query parameters to billing account scope. Updated example. Added documentation around size response limit
    
    * Ran prettify and fixed typo
    
    * Adding suppression for valid formats
    
    * Single directives (Azure#23014)
    
    ---------
    
    Co-authored-by: MattEberhart-MSFTE <107518095+MattEberhart-MSFTE@users.noreply.github.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    3 participants