-
Notifications
You must be signed in to change notification settings - Fork 5.6k
DiskRP swagger changes for api version 2024-03-02 #29564
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
Closed
kbaibhavgithub
wants to merge
1
commit into
Azure:feature/cplat-2024-03-02
from
kbaibhavgithub:patch-1
Closed
DiskRP swagger changes for api version 2024-03-02 #29564
kbaibhavgithub
wants to merge
1
commit into
Azure:feature/cplat-2024-03-02
from
kbaibhavgithub:patch-1
Conversation
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
…iskRestorePointProperties"
Next Steps to MergeNext steps that must be taken to merge this PR:
|
Swagger Validation Report
|
| Compared specs (v0.10.12) | new version | base version |
|---|---|---|
| diskRestorePoint.json | 2024-03-02(2905f5a) | 2023-10-02(main) |
️❌LintDiff: 1 Errors, 0 Warnings failed [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| package-2024-03-02 | package-2024-03-02(2905f5a) | package-2024-03-02(feature/cplat-2024-03-02) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L380 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
ResourceNameRestriction |
The resource name parameter 'restorePointCollectionName' should be defined with a 'pattern' restriction. Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L37 |
ResourceNameRestriction |
The resource name parameter 'vmRestorePointName' should be defined with a 'pattern' restriction. Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L37 |
ResourceNameRestriction |
The resource name parameter 'diskRestorePointName' should be defined with a 'pattern' restriction. Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L37 |
ResourceNameRestriction |
The resource name parameter 'restorePointCollectionName' should be defined with a 'pattern' restriction. Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L88 |
ResourceNameRestriction |
The resource name parameter 'vmRestorePointName' should be defined with a 'pattern' restriction. Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L88 |
ResourceNameRestriction |
The resource name parameter 'restorePointCollectionName' should be defined with a 'pattern' restriction. Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L136 |
ResourceNameRestriction |
The resource name parameter 'vmRestorePointName' should be defined with a 'pattern' restriction. Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L136 |
ResourceNameRestriction |
The resource name parameter 'diskRestorePointName' should be defined with a 'pattern' restriction. Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L136 |
LroLocationHeader |
A 202 response should include an Location response header. Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L179 |
ResourceNameRestriction |
The resource name parameter 'restorePointCollectionName' should be defined with a 'pattern' restriction. Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L200 |
ResourceNameRestriction |
The resource name parameter 'vmRestorePointName' should be defined with a 'pattern' restriction. Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L200 |
ResourceNameRestriction |
The resource name parameter 'diskRestorePointName' should be defined with a 'pattern' restriction. Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L200 |
PostResponseCodes |
200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L201 |
LroLocationHeader |
A 202 response should include an Location response header. Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L231 |
MissingTypeObject |
The schema 'DiskRestorePoint' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L254 |
MissingTypeObject |
The schema 'DiskRestorePointList' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L268 |
MissingTypeObject |
The schema 'DiskRestorePointProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L287 |
MissingTypeObject |
The schema 'ProxyOnlyResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L388 |
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'DiskRestorePointModel'. Consider using the plural form of 'DiskRestorePoint' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L42 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L44 |
|
| A nested resource type's List operation must include all the parent segments in its api path. Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L88 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'DiskRestorePointModel'. Consider using the plural form of 'DiskRestorePoint' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L93 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L95 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get an incremental disk restorePoint resource. Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L126 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'DiskRestorePointModel'. Consider using the plural form of 'DiskRestorePoint' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L141 |
|
| OperationId should contain the verb: 'begingetaccess' in:'DiskRestorePoint_GrantAccess'. Consider updating the operationId Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L141 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L143 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'DiskRestorePointModel'. Consider using the plural form of 'DiskRestorePoint' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L205 |
|
| OperationId should contain the verb: 'endgetaccess' in:'DiskRestorePoint_RevokeAccess'. Consider updating the operationId Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L205 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: DiskRP/stable/2024-03-02/diskRestorePoint.json#L207 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/compute/resource-manager/readme.md tag: specification/compute/resource-manager/readme.md#tag-package-2024-03-01 |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Jun 25, 2024
Contributor
|
Please fix the Swagger LintDiff and Swagger Avocado errors. |
Contributor
Author
|
created consolidated PR: #29602 |
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.
DiskRP swagger changes for api version 2024-03-02