-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
update example name in reservations #22338
Merged
Merged
Conversation
This file contains 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
Hi, @kazrael2119 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. [email protected] |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
reservations.json | 2022-11-01(5d851df) | 2022-11-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.0.0) | new version | base version |
---|---|---|
package-2022-11 | package-2022-11(5d851df) | package-2022-11(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
PostOperationAsyncResponseValidation |
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L31 |
PostOperationAsyncResponseValidation |
An async POST operation must return 202. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L58 |
AllResourcesMustHaveDelete |
The resource ReservationOrderResponse does not have a corresponding delete operation. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L272 |
PathForPutOperation |
The path for 'put' operation must be under a subscription and resource group. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L272 |
CreateOperationAsyncResponseValidation |
An async PUT operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'azure-async-operation' on 'x-ms-long-running-operation-options' Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L273 |
LongRunningResponseStatusCode |
A 'put' operation 'ReservationOrder_Purchase' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L273 |
CreateOperationAsyncResponseValidation |
An async PUT operation must return 201. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L300 |
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L307 |
TrackedResourcesMustHavePut |
The tracked resource ReservationResponse does not have a corresponding put operation. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L540 |
ConsistentPatchProperties |
The property 'properties.name' in the request body either not apppear in the resource model or has the wrong level. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L605 |
PatchSkuProperty |
The patch operation body parameter schema should contains property 'sku'. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L605 |
PostOperationAsyncResponseValidation |
An async POST operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L891 |
PostOperationAsyncResponseValidation |
An async POST operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L950 |
ProvisioningStateValidation |
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L1193 |
TopLevelResourcesListBySubscription |
The top-level resource 'ReservationOrderResponse' does not have list by subscription operation, please add it. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L1671 |
A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L30 |
|
The x-ms-long-running-operation-options should be specified explicitly to indicate the type of response header to track the async operation. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L31 |
|
Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L75 |
|
OperationId should contain the verb: 'calculateprice' in:'ReservationOrder_Calculate'. Consider updating the operationId Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L202 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'ReservationOrder_Purchase' Request Model: 'parameters[2].schema' Response Model: 'responses[200].schema' Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L273 |
|
'PUT' operation 'ReservationOrder_Purchase' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L276 |
|
OperationId should contain the verb: 'calculaterefund' in:'CalculateRefund_Post'. Consider updating the operationId Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L805 |
|
OperationId should contain the verb: 'return' in:'Return_Post'. Consider updating the operationId Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L845 |
|
OperationId should contain the verb: 'calculateexchange' in:'CalculateExchange_Post'. Consider updating the operationId Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L894 |
|
OperationId should contain the verb: 'exchange' in:'Exchange_Post'. Consider updating the operationId Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L953 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L1290 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L1315 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L1324 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L1367 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Capacity/stable/2022-11-01/reservations.json#L1376 |
️⚠️
Avocado: 1 Warnings warning [Detail]
Rule | Message |
---|---|
The default tag contains multiple API versions swaggers. readme: specification/reservations/resource-manager/readme.md tag: specification/reservations/resource-manager/readme.md#tag-package-2022-11 |
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️
~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️
~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
~[Staging] CadlAPIView 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).
️️✔️
CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Jan 28, 2023
Closed
qiaozha
approved these changes
Jan 29, 2023
tadelesh
added
the
Approved-SdkBreakingChange-Go
Approve the breaking change tracking for azure-sdk-for-go
label
Jan 29, 2023
This was referenced Jan 29, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Approved-SdkBreakingChange-Go
Approve the breaking change tracking for azure-sdk-for-go
CI-BreakingChange-Go
resource-manager
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.
js generate sample error:
it caused by swagger: