Conversation
|
Hi, @sumitparwal! 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 Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| consumption.json | 2023-11-01(723db51) | 2023-05-01(main) |
| consumption.json | 2023-11-01(723db51) | 2019-05-01-preview(main) |
| consumption_pricesheet.json | 2023-11-01(723db51) | 2023-05-01(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️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-11 | package-2023-11(723db51) | default(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
PathForResourceAction |
Path for 'post' method on a resource type MUST follow valid resource naming. Location: Microsoft.Consumption/stable/2023-11-01/consumption_pricesheet.json#L37 |
GetOperation200 |
The get operation should only return 200. Location: Microsoft.Consumption/stable/2023-11-01/consumption.json#L155 |
GetOperation200 |
The get operation should only return 200. Location: Microsoft.Consumption/stable/2023-11-01/consumption.json#L252 |
NoDuplicatePathsForScopeParameter |
Path '/{scope}/providers/Microsoft.Consumption/budgets/{budgetName}' with explicitly defined scope is a duplicate of path '/{scope}/providers/Microsoft.Consumption/budgets' that has the scope parameter.'. Location: Microsoft.Consumption/stable/2023-11-01/consumption.json#L267 |
ResourceNameRestriction |
The resource name parameter 'budgetName' should be defined with a 'pattern' restriction. Location: Microsoft.Consumption/stable/2023-11-01/consumption.json#L309 |
PutResponseSchemaDescription |
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.Consumption/stable/2023-11-01/consumption.json#L384 |
DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Consumption/stable/2023-11-01/consumption.json#L430 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Consumption/stable/2023-11-01/consumption.json#L469 |
GetOperation200 |
The get operation should only return 200. Location: Microsoft.Consumption/stable/2023-11-01/consumption.json#L473 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Consumption/stable/2023-11-01/consumption.json#L577 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Consumption/stable/2023-11-01/consumption.json#L616 |
ResourceNameRestriction |
The resource name parameter 'billingPeriodName' should be defined with a 'pattern' restriction. Location: Microsoft.Consumption/stable/2023-11-01/consumption.json#L629 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Consumption/stable/2023-11-01/consumption.json#L658 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Consumption/stable/2023-11-01/consumption.json#L1109 |
GetOperation200 |
The get operation should only return 200. Location: Microsoft.Consumption/stable/2023-11-01/consumption.json#L1113 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Consumption/stable/2023-11-01/consumption.json#L1181 |
GetOperation200 |
The get operation should only return 200. Location: Microsoft.Consumption/stable/2023-11-01/consumption.json#L1185 |
ParametersInPointGet |
Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.Consumption/stable/2023-11-01/consumption.json#L1319 |
ParametersInPointGet |
Query parameter $skiptoken should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.Consumption/stable/2023-11-01/consumption.json#L1319 |
ParametersInPointGet |
Query parameter $top should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.Consumption/stable/2023-11-01/consumption.json#L1319 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Consumption/stable/2023-11-01/consumption.json#L1354 |
ResourceNameRestriction |
The resource name parameter 'billingPeriodName' should be defined with a 'pattern' restriction. Location: Microsoft.Consumption/stable/2023-11-01/consumption.json#L1367 |
ParametersInPointGet |
Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.Consumption/stable/2023-11-01/consumption.json#L1385 |
ParametersInPointGet |
Query parameter $skiptoken should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.Consumption/stable/2023-11-01/consumption.json#L1385 |
ParametersInPointGet |
Query parameter $top should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.Consumption/stable/2023-11-01/consumption.json#L1385 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Consumption/stable/2023-11-01/consumption.json#L1423 |
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/2023-11-01/consumption.json#L1456 |
OperationsApiSchemaUsesCommonTypes |
Operations API path must follow the schema provided in the common types. Location: Microsoft.Consumption/stable/2023-11-01/consumption.json#L1457 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Consumption/stable/2023-11-01/consumption.json#L1508 |
ResourceNameRestriction |
The resource name parameter 'billingPeriodName' should be defined with a 'pattern' restriction. Location: Microsoft.Consumption/stable/2023-11-01/consumption.json#L1521 |
️️✔️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]
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Aug 4, 2023
This was referenced Aug 4, 2023
… 2023 11 01 (#25185) * updated documentation * fixed prettier check * fixed name
Member
|
this js sdk breaking is not caused by this pr |
rkmanda
approved these changes
Aug 15, 2023
This was referenced Aug 15, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
ARMChangesRequestedis removed from your PR. This should cause the label
WaitForARMFeedbackto 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 helpsection 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)
ARMReviewlabel.Getting help
and https://aka.ms/ci-fix.