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

Updated RI Usage details API description #19618

Conversation

csurf987
Copy link
Contributor

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

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. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No refresh required for updates in this PR

Contribution checklist:

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 appy 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 are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

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

@csurf987 csurf987 requested a review from kjeur as a code owner June 27, 2022 23:44
@openapi-workflow-bot
Copy link

Hi, @csurf987 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 Jun 27, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    compared swaggers (via Oad v0.9.6)] new version base version
    consumption.json 2021-10-01(7d4cee9) 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 v1.13.0) new version base version
    package-2021-10 package-2021-10(7d4cee9) 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
    R4011 - 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
    R4018 - 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#L1427
    R4037 - 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
    R4037 - 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
    R4037 - 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
    R4037 - 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
    R4037 - MissingTypeObject The schema 'ReservationSummariesListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L2986
    R4037 - MissingTypeObject The schema 'ReservationSummaryProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L3004
    R4037 - MissingTypeObject The schema 'ReservationDetailsListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L3111
    R4037 - MissingTypeObject The schema 'ReservationDetailProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L3129
    R4037 - MissingTypeObject The schema 'ReservationRecommendationDetailsProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L3217
    R4037 - MissingTypeObject The schema 'ReservationRecommendationDetailsCalculatedSavingsProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L3252
    R4037 - MissingTypeObject The schema 'ReservationRecommendationDetailsResourceProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L3291
    R4037 - MissingTypeObject The schema 'ReservationRecommendationDetailsSavingsProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L3329
    R4037 - MissingTypeObject The schema 'ReservationRecommendationDetailsUsageProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L3368
    R4037 - MissingTypeObject The schema 'ReservationRecommendationsListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L3401
    R4037 - MissingTypeObject The schema 'SkuProperty' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L3598
    R4037 - MissingTypeObject The schema 'ModernReservationRecommendationProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L3633
    R4037 - MissingTypeObject The schema 'ModernReservationTransactionProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L3728
    R4037 - MissingTypeObject The schema 'LegacyReservationTransactionProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L3875
    R4037 - MissingTypeObject The schema 'ReservationTransactionsListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L4018
    R4037 - MissingTypeObject The schema 'ModernReservationTransactionsListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L4036
    R4037 - MissingTypeObject The schema 'TagProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L4070
    R4037 - MissingTypeObject The schema 'Tag' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L4095
    R4037 - MissingTypeObject The schema 'BudgetsListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L4111
    R4037 - MissingTypeObject The schema 'BudgetProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L4145
    R4037 - MissingTypeObject The schema 'BudgetTimePeriod' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L4216
    R4037 - MissingTypeObject The schema 'BudgetFilter' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L4234
    R4037 - MissingTypeObject The schema 'BudgetFilterProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L4256
    R4037 - MissingTypeObject The schema 'BudgetComparisonExpression' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L4269
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck 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.
    ️⚠️SDK Track2 Validation: 2 Warnings warning [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ IgnoredPropertyNextToRef "readme":"consumption/resource-manager/readme.md",
    "tag":"package-2021-10",
    "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > BudgetProperties > properties > filter)\n keys: [ \u001b[32m'type'\u001b[39m ]"
    ⚠️ IgnoredPropertyNextToRef "readme":"consumption/resource-manager/readme.md",
    "tag":"package-2021-10",
    "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > BudgetProperties > properties > notifications > additionalProperties)\n keys: [ \u001b[32m'type'\u001b[39m ]"
    💬 "readme":"consumption/resource-manager/readme.md",
    "tag":"package-2021-10",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0 -> 1.11.0)"
    💬 "readme":"consumption/resource-manager/readme.md",
    "tag":"package-2021-10",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0->1.11.0)"
    💬 "readme":"consumption/resource-manager/readme.md",
    "tag":"package-2021-10",
    "details":"> Installing AutoRest extension '@autorest/modelerfour' (4.21.4 -> 4.21.4)"
    💬 "readme":"consumption/resource-manager/readme.md",
    "tag":"package-2021-10",
    "details":"> Installed AutoRest extension '@autorest/modelerfour' (4.21.4->4.21.4)"
    💬 "readme":"consumption/resource-manager/readme.md",
    "tag":"package-2021-10",
    "details":"Autorest completed in 15.35s. 0 files generated."


    The following errors/warnings exist before current PR submission:

    Rule Message
    ⚠️ DeprecatedConfig "readme":"consumption/resource-manager/readme.md",
    "tag":"package-2021-10",
    "details":"Using directive.0.suppress which is deprecated and will be removed in the future."
    💬 "readme":"consumption/resource-manager/readme.md",
    "tag":"package-2021-10",
    "details":"AutoRest core version selected from configuration: ^3.2.0."
    ️️✔️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 Jun 27, 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 - armconsumption - 1.1.0
    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-consumption - 10.0.0
    azure-sdk-for-js - @azure/arm-consumption - Approved - 10.0.0
    ️❌ azure-sdk-for-net failed [Detail]
    • Failed [Logs]Release - Generate from 2794e65. 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/consumption/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 2794e65. 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
    • ️✔️armconsumption [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New const `EventTypeCreditExpired`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 1 additive change(s).
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 2794e65. 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] WARN config global `--global`, `--local` are deprecated. Use `--location=global` instead.
      cmderr	[automation_generate.sh] npm notice
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.11.0 -> 8.13.2
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.13.2>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@8.13.2` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-consumption [View full logs]  [Release SDK Changes]
      info	[Changelog]
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 2794e65. 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
      cmderr	[automation_init.sh] deprecated read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
      cmderr	[automation_init.sh] deprecated uuid@3.4.0: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
      cmderr	[automation_init.sh] npm WARN deprecated @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
      cmderr	[automation_init.sh] WARN deprecated @azure/storage-blob@10.5.0: This version has been deprecated, please upgrade to the version tagged as latest
      cmderr	[automation_init.sh] npm WARN @octokit/plugin-request-log@1.0.4 requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
      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 Type Alias LotsListByCustomerNextResponse
      info	[Changelog]   - Added Type Alias LotsListByCustomerResponse
      info	[Changelog]   - Type Alias LegacyUsageDetail has a new parameter benefitId
      info	[Changelog]   - Type Alias LegacyUsageDetail has a new parameter benefitName
      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
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 2794e65. 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 2794e65. 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?

    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.

    2 participants