-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
[Hub Generated] Review request for Microsoft.CostManagement to add version stable/2023-08-01 #25305
[Hub Generated] Review request for Microsoft.CostManagement to add version stable/2023-08-01 #25305
Conversation
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
costmanagement.exports.json | 2023-08-01(adf2e88) | 2023-08-01(main) |
costallocation.json | 2023-08-01(adf2e88) | 2023-08-01(main) |
settings.json | 2023-08-01(adf2e88) | 2023-08-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.1.4) | new version | base version |
---|---|---|
package-2023-08 | package-2023-08(adf2e88) | package-2023-08(main) |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
NoDuplicatePathsForScopeParameter |
Path '/{scope}/providers/Microsoft.CostManagement/exports/{exportName}' with explicitly defined scope is a duplicate of path '/{scope}/providers/Microsoft.CostManagement/exports' that has the scope parameter.'. Location: Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json#L36 |
NoDuplicatePathsForScopeParameter |
Path '/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/run' with explicitly defined scope is a duplicate of path '/{scope}/providers/Microsoft.CostManagement/exports' that has the scope parameter.'. Location: Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json#L36 |
NoDuplicatePathsForScopeParameter |
Path '/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory' with explicitly defined scope is a duplicate of path '/{scope}/providers/Microsoft.CostManagement/exports' that has the scope parameter.'. Location: Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json#L36 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json#L84 |
NoDuplicatePathsForScopeParameter |
Path '/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/run' with explicitly defined scope is a duplicate of path '/{scope}/providers/Microsoft.CostManagement/exports/{exportName}' that has the scope parameter.'. Location: Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json#L97 |
NoDuplicatePathsForScopeParameter |
Path '/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory' with explicitly defined scope is a duplicate of path '/{scope}/providers/Microsoft.CostManagement/exports/{exportName}' that has the scope parameter.'. Location: Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json#L97 |
ResourceNameRestriction |
The resource name parameter 'exportName' should be defined with a 'pattern' restriction. Location: Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json#L97 |
ParametersInPointGet |
Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json#L127 |
PutResponseSchemaDescription |
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json#L209 |
DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json#L270 |
NoDuplicatePathsForScopeParameter |
Path '/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory' with explicitly defined scope is a duplicate of path '/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/run' that has the scope parameter.'. Location: Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json#L283 |
ResourceNameRestriction |
The resource name parameter 'exportName' should be defined with a 'pattern' restriction. Location: Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json#L283 |
SyncPostReturn |
200 response for a synchronous POST operation must have a response schema specified. Location: Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json#L284 |
ResourceNameRestriction |
The resource name parameter 'exportName' should be defined with a 'pattern' restriction. Location: Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json#L337 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json#L381 |
TopLevelResourcesListBySubscription |
The top-level resource 'Export' does not have list by subscription operation, please add it. Location: Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json#L410 |
Based on the response model schema, operation 'Exports_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json#L37 |
|
Not using the common-types defined parameter 'scope'. Location: Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json#L66 |
|
The response of operation:'Exports_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json#L98 |
|
Not using the common-types defined parameter 'scope'. Location: Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json#L127 |
|
The response of operation:'Exports_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json#L160 |
|
Not using the common-types defined parameter 'scope'. Location: Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json#L189 |
|
Not using the common-types defined parameter 'scope'. Location: Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json#L259 |
|
OperationId should contain the verb: 'run' in:'Exports_Execute'. Consider updating the operationId Location: Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json#L288 |
|
Not using the common-types defined parameter 'scope'. Location: Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json#L313 |
|
Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json#L338 |
|
Based on the response model schema, operation 'Exports_GetExecutionHistory' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json#L338 |
|
Not using the common-types defined parameter 'scope'. Location: Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json#L367 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
TypeSpecAPIView 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).
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️
Automated merging requirements met succeeded [Detail] [Expand]
Hi, @thramu! Thank you for your pull request. To help get your PR merged: Generated ApiView comment added to this PR. You can use ApiView to show API versions diff. |
Swagger Generation Artifacts
|
Generated ApiView
|
Hi @thramu! The automation detected this pull request introduces changes to at least one existing API version that violate Azure's versioning policy. To comply with the policy, these changes must be made in a new API version. As a result, the automation added the
|
Hi @thramu, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval. |
Please address or respond to feedback from the ARM API reviewer. |
Next Steps to Merge |
Hi @thramu! Your PR has some issues. Please fix the CI issues, if present, in following order:
If you need further help, please reach out on the Teams channel aka.ms/azsdk/support/specreview-channel. |
Automatic PR validation restarted. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛. |
Automatic PR validation restarted. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛. |
Automatic PR validation restarted. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛. |
[ARMGuidelineFalsePositive] We get for the check name availability response, but I consider that a false positive, because its following the guidance from the RPC.
|
Automatic PR validation started. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛. |
...on/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/settings.json
Show resolved
Hide resolved
...on/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/settings.json
Show resolved
Hide resolved
Basically looks good to me, minor feedbacks, I don't think they're truly blocking. |
/pr RequestMerge |
Swagger pipeline restarted successfully, please wait for status update in this comment. |
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM (Control Plane) API Specification Update Pull Request
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
[1] public repo review queue, private repo review queue
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label
ARMChangesRequested
is removed from your PR. This should cause the label
WaitForARMFeedback
to be added.[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue
If you need further help with anything, see
Getting help
section below.Purpose of this PR
What's the purpose of this PR? Check all that apply. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to Step 2, "ARM Review", for this PR.
Breaking changes review (Step 1)
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
ARM API changes review (Step 2)
ARMReview
label.Getting help
and https://aka.ms/ci-fix.