Add pagination to cost management Query API#19458
Add pagination to cost management Query API#19458GuillaumeColom wants to merge 1 commit intoAzure:mainfrom
Conversation
|
Hi, @GuillaumeColom Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Validation Report
|
| 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]
- Compared Swaggers (Based on Oad v0.9.5)
- current:preview/2022-07-01-preview/common-types.json compared with base:stable/2021-10-01/common-types.json
| 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).
|
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). |
Swagger Generation Artifacts
|
|
Hi @GuillaumeColom, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
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. |
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
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. |
|
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. |
Changelog
Add a changelog entry for this PR by answering the following questions:
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
July 2022
July 2022
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
I don't have access to contribution documentation.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
-[ ] 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.
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.
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.