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

Update Reservation details description #22437

Merged
merged 1 commit into from
Feb 3, 2023

Conversation

pednekarpraj
Copy link
Contributor

@pednekarpraj pednekarpraj commented Feb 3, 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.

@pednekarpraj pednekarpraj requested a review from kjeur as a code owner February 3, 2023 02:05
@openapi-workflow-bot
Copy link

Hi, @pednekarpraj 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 3, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    compared swaggers (via Oad v0.10.4)] new version base version
    consumption.json 2021-10-01(3472004) 2021-10-01(main)
    ️️✔️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.0.0) new version base version
    package-2021-10 package-2021-10(3472004) package-2021-10(main)

    The following errors/warnings exist before current PR submission:

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

    Rule Message
    GetOperation200 The get operation should only return 200.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L155
    GetOperation200 The get operation should only return 200.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L252
    ResourceNameRestriction The resource name parameter 'budgetName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L309
    DeleteOperationResponses The delete operation is defined without a 200 or 204 error response implementation,please add it.'
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L430
    GetOperation200 The get operation should only return 200.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L473
    ResourceNameRestriction The resource name parameter 'billingPeriodName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L629
    GetOperation200 The get operation should only return 200.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1113
    TrackedResourcePatchOperation Tracked resource 'ReservationRecommendationDetailsModel' must have patch operation that at least supports the update of tags.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1128
    TrackedResourcesMustHavePut The tracked resource ReservationRecommendationDetailsModel does not have a corresponding put operation.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1128
    GetOperation200 The get operation should only return 200.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1182
    ResourceNameRestriction The resource name parameter 'billingPeriodName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1358
    OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.Consumption/operations' does not match the ARM specification. Please standardize the schema.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1447
    ResourceNameRestriction The resource name parameter 'billingPeriodName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1512
    GetOperation200 The get operation should only return 200.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1842
    MissingTypeObject The schema 'MeterDetails' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1856
    ValidFormats 'decimal' is not a known format.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1887
    ValidFormats 'decimal' is not a known format.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1893
    MissingTypeObject The schema 'UsageDetailsListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1935
    MissingTypeObject The schema 'LegacyUsageDetailProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1973
    ValidFormats 'decimal' is not a known format.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L2058
    ValidFormats 'decimal' is not a known format.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L2064
    ValidFormats 'decimal' is not a known format.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L2070
    ValidFormats 'decimal' is not a known format.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L2076
    ValidFormats 'decimal' is not a known format.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L2197
    MissingTypeObject The schema 'ModernUsageDetailProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L2246
    ValidFormats 'decimal' is not a known format.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L2257
    ValidFormats 'decimal' is not a known format.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L2356
    ValidFormats 'decimal' is not a known format.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L2372
    ValidFormats 'decimal' is not a known format.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L2378
    ValidFormats 'decimal' is not a known format.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L2484
    ️️✔️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]
    ️️✔️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 3, 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/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 8021313. 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 8021313. 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]  New major version of npm available! 8.19.3 -> 9.4.1
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.4.1>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.4.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 8021313. 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 available: 22.3.1 -> 23.0
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      cmderr	[init.sh] [notice] A new release of pip available: 22.3.1 -> 23.0
      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 8021313. 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 8021313. 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 8021313. 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 3, 2023

    Generated ApiView

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

    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