Skip to content

Add pagination to cost management Query API#19458

Closed
GuillaumeColom wants to merge 1 commit intoAzure:mainfrom
GuillaumeColom:add-pagination-to-cost-management-query-api
Closed

Add pagination to cost management Query API#19458
GuillaumeColom wants to merge 1 commit intoAzure:mainfrom
GuillaumeColom:add-pagination-to-cost-management-query-api

Conversation

@GuillaumeColom
Copy link
Contributor

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

Add "$skipToken" parameter to CostManagement Query API for pagination.
The nextLink element already exists in response and already contains the "$skipToken" parameter.
We already can send the "$skipToken" as a query parameter and it works but it doesn't appear in the API spec.

This pull request simply declares the "$skipToken" parameter in CostManagement Query API specs.
(Query_Usage and Query_UsageByExternalCloudProviderType)
Linked to another pull request to Azure SDK for Java : Azure/azure-sdk-for-java#29381

  1. 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.

July 2022

  1. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.

July 2022

  1. 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:

I don't have access to contribution documentation.

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.

I don't have access to this documentation.

I don't have access to this documentation.

  • 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.

@openapi-workflow-bot
Copy link

Hi, @GuillaumeColom 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-workflow-bot openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jun 15, 2022
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 15, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.

    ️❌Avocado: 23 Errors, 0 Warnings failed [Detail]
    Rule Message
    UNREFERENCED_JSON_FILE The swagger JSON file is not referenced from the readme file.
    readme: specification/cost-management/resource-manager/readme.md
    json: Microsoft.CostManagement/preview/2022-07-01-preview/costmanagement.json
    UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
    readme: specification/cost-management/resource-manager/readme.md
    json: preview/2022-07-01-preview/examples/BillingAccountQuery.json
    UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
    readme: specification/cost-management/resource-manager/readme.md
    json: preview/2022-07-01-preview/examples/BillingAccountQueryGrouping.json
    UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
    readme: specification/cost-management/resource-manager/readme.md
    json: preview/2022-07-01-preview/examples/DepartmentQuery.json
    UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
    readme: specification/cost-management/resource-manager/readme.md
    json: preview/2022-07-01-preview/examples/DepartmentQueryGrouping.json
    UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
    readme: specification/cost-management/resource-manager/readme.md
    json: preview/2022-07-01-preview/examples/EnrollmentAccountQuery.json
    UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
    readme: specification/cost-management/resource-manager/readme.md
    json: preview/2022-07-01-preview/examples/EnrollmentAccountQueryGrouping.json
    UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
    readme: specification/cost-management/resource-manager/readme.md
    json: preview/2022-07-01-preview/examples/ExternalBillingAccountsQuery.json
    UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
    readme: specification/cost-management/resource-manager/readme.md
    json: preview/2022-07-01-preview/examples/ExternalSubscriptionsQuery.json
    UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
    readme: specification/cost-management/resource-manager/readme.md
    json: preview/2022-07-01-preview/examples/MCABillingAccountQuery.json
    UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
    readme: specification/cost-management/resource-manager/readme.md
    json: preview/2022-07-01-preview/examples/MCABillingAccountQueryGrouping.json
    UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
    readme: specification/cost-management/resource-manager/readme.md
    json: preview/2022-07-01-preview/examples/MCABillingProfileQuery.json
    UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
    readme: specification/cost-management/resource-manager/readme.md
    json: preview/2022-07-01-preview/examples/MCABillingProfileQueryGrouping.json
    UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
    readme: specification/cost-management/resource-manager/readme.md
    json: preview/2022-07-01-preview/examples/MCACustomerQuery.json
    UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
    readme: specification/cost-management/resource-manager/readme.md
    json: preview/2022-07-01-preview/examples/MCACustomerQueryGrouping.json
    UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
    readme: specification/cost-management/resource-manager/readme.md
    json: preview/2022-07-01-preview/examples/MCAInvoiceSectionQuery.json
    UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
    readme: specification/cost-management/resource-manager/readme.md
    json: preview/2022-07-01-preview/examples/MCAInvoiceSectionQueryGrouping.json
    UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
    readme: specification/cost-management/resource-manager/readme.md
    json: preview/2022-07-01-preview/examples/ManagementGroupQuery.json
    UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
    readme: specification/cost-management/resource-manager/readme.md
    json: preview/2022-07-01-preview/examples/ManagementGroupQueryGrouping.json
    UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
    readme: specification/cost-management/resource-manager/readme.md
    json: preview/2022-07-01-preview/examples/ResourceGroupQuery.json
    UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
    readme: specification/cost-management/resource-manager/readme.md
    json: preview/2022-07-01-preview/examples/ResourceGroupQueryGrouping.json
    UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
    readme: specification/cost-management/resource-manager/readme.md
    json: preview/2022-07-01-preview/examples/SubscriptionQuery.json
    UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
    readme: specification/cost-management/resource-manager/readme.md
    json: preview/2022-07-01-preview/examples/SubscriptionQueryGrouping.json
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️❌ModelValidation: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    unacceptable kind of an object to dump [object Error] "role":"Model Validation",
    "url":"https://github.com/Azure/azure-rest-api-specs/blob/c79ff5dd9d8eab398d749648974c24d0fb16e64c/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-07-01-preview/costmanagement.json"
    ️❌SemanticValidation: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    INTERNAL_ERROR Unexpected internal error: ENOENT: no such file or directory, open 'specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-07-01-preview/examples/PrivateViewList.json' Error: ENOENT: no such file or directory, open 'specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-07-01-preview/examples/PrivateViewList.json'
    JsonUrl: Microsoft.CostManagement/preview/2022-07-01-preview/costmanagement.json
    ️❌Cross-Version Breaking Changes: 2 Errors, 0 Warnings failed [Detail]
    The following breaking changes are detected by comparison with the latest stable version:
    Rule Message
    Runtime Exception "new":"https://github.com/Azure/azure-rest-api-specs/blob/c79ff5dd9d8eab398d749648974c24d0fb16e64c/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-07-01-preview/costmanagement.json",
    "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/costmanagement.json",
    "details":"Command failed: node /mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.30/common/temp/node_modules/.pnpm/@Azure+oad@0.9.5/node_modules/autorest/dist/app.js --v2 --input-file=specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-07-01-preview/costmanagement.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp\nERROR: Referenced file 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-07-01-preview/examples/OperationList.json' not found\n - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-07-01-preview/costmanagement.json:1264:12 ($.paths["/providers/Microsoft.CostManagement/operations"].get["x-ms-examples"].OperationList["$ref"])\nFATAL: swagger-document/loader - FAILED\nFATAL: Error: [OperationAbortedException] Error occur"


    The following breaking changes are detected by comparison with latest preview version:

    Rule Message
    Runtime Exception "new":"https://github.com/Azure/azure-rest-api-specs/blob/c79ff5dd9d8eab398d749648974c24d0fb16e64c/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-07-01-preview/costmanagement.json",
    "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-04-01-preview/costmanagement.json",
    "details":"Command failed: node /mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.30/common/temp/node_modules/.pnpm/@Azure+oad@0.9.5/node_modules/autorest/dist/app.js --v2 --input-file=specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-07-01-preview/costmanagement.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp\nERROR: Referenced file 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-07-01-preview/examples/OperationList.json' not found\n - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-07-01-preview/costmanagement.json:1264:12 ($.paths["/providers/Microsoft.CostManagement/operations"].get["x-ms-examples"].OperationList["$ref"])\nFATAL: swagger-document/loader - FAILED\nFATAL: Error: [OperationAbortedException] Error occur"
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation
    ️️✔️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).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi, @GuillaumeColom your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 15, 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.0.1
    azure-sdk-for-python-track2 - track2_azure-mgmt-costmanagement - 3.0.0
    ️❌ azure-sdk-for-net failed [Detail]
    • Failed [Logs] Generate from d3e802e1a9494fa474e2a82efbee3658e3e84028. 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] Generate from d3e802e1a9494fa474e2a82efbee3658e3e84028. 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]  [Preview SDK Changes]
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from d3e802e1a9494fa474e2a82efbee3658e3e84028. 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]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      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] Generate from d3e802e1a9494fa474e2a82efbee3658e3e84028. 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]  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] Generate from d3e802e1a9494fa474e2a82efbee3658e3e84028. 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]  [Preview SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

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

    @zizw123
    Copy link

    zizw123 commented Jun 15, 2022

    The first commit needs to be the previous api version and the new changes should only be added in the subsequent commits. This is explained in detail here (If using Open API which is recommended) https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/208/OpenAPI-Hub-Adding-new-API-version or here(For manual process) : https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/83/Manual-Process-Adding-new-API-version . Please remove the "ARMChangesRequested" tag once you have fixed this issue.

    @openapi-workflow-bot
    Copy link

    Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 15, 2022
    @GuillaumeColom
    Copy link
    Contributor Author

    GuillaumeColom commented Jun 21, 2022

    The first commit needs to be the previous api version and the new changes should only be added in the subsequent commits. This is explained in detail here (If using Open API which is recommended) https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/208/OpenAPI-Hub-Adding-new-API-version or here(For manual process) : https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/83/Manual-Process-Adding-new-API-version . Please remove the "ARMChangesRequested" tag once you have fixed this issue.

    Hello,

    I'm not a Microsoft employee or even a contributor. I am a customer.

    The provided azure devops links are not public (getting 401 error). Could you point me to the appropriate procedure ?

    Thank you for your help.

    @xiaoxuqi-ms
    Copy link
    Member

    Hi @GuillaumeColom , hope the following message help.

    Please note that it is time-consuming to review the file line by line for every api-version. When you are creating the swagger specification for the new api-version, please copy the swagger specification from the previous version into the new api-versioned folder and commit it. After that overwrite it with the changes for the new api-version. This makes it easy for us to review the changes.
    Update and commit the specification files as needed to the master of your forked repository or to any branch in your forked repository.
    Submit a pull request to the master branch of the azure-rest-api-specs repository from the master of your fork or whichever branch you committed your changes to (more info on creating pull requests ).

    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