[DevCenter] Add 2023-10-01-preview dataplane API version #26049
Merged
This check has been archived and is scheduled for deletion.
Learn more about checks retention
openapi-pipeline-app / ~[NotRequired_Staging] Swagger LintDiff
completed
Oct 18, 2023 in 2m 55s
~[NotRequired_Staging] Swagger LintDiff failed
ppe/LintDiff: 11 Errors, 31 Warnings
The check status is neutral due to the check was suppressed by label Approved-LintDiff. If you have any question, pls contact [email protected]
View more details.
Details
| compared tags (via openapi-validator vbeta) | new version | base version |
|---|---|---|
| package-2023-10-01-preview | package-2023-10-01-preview(88881ce) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
Per the Noun_Verb convention for Operation Ids, the noun 'Environments' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DevCenter/preview/2023-10-01-preview/environments.json#L284 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.DevCenter/preview/2023-10-01-preview/environments.json#L1230 |
||
| 'PATCH' operation 'Environments_PatchEnvironment' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DevCenter/preview/2023-10-01-preview/environments.json#L284 |
||
| OperationId for patch method should contain 'Update' Location: Microsoft.DevCenter/preview/2023-10-01-preview/environments.json#L284 |
||
| Operation does not define an 'api-version' query parameter. Location: Microsoft.DevCenter/preview/2023-10-01-preview/environments.json#L264 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L2014 |
||
| Error response should contain a x-ms-error-code header. Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L423 |
||
| Schema with type: number should specify format Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L419 |
||
| A 202 response should include an Operation-Location response header. Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L417 |
||
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L388 |
RPC-Async-V1-05 | |
| Error response should contain a x-ms-error-code header. Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L374 |
||
| Error response should contain a x-ms-error-code header. Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L322 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
Per the Noun_Verb convention for Operation Ids, the noun 'Environments' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DevCenter/preview/2023-10-01-preview/environments.json#L1043 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Environments' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DevCenter/preview/2023-10-01-preview/environments.json#L998 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Environments' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DevCenter/preview/2023-10-01-preview/environments.json#L947 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Environments' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DevCenter/preview/2023-10-01-preview/environments.json#L896 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Environments' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DevCenter/preview/2023-10-01-preview/environments.json#L330 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Environments' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DevCenter/preview/2023-10-01-preview/environments.json#L219 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Environments' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DevCenter/preview/2023-10-01-preview/environments.json#L164 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Environments' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DevCenter/preview/2023-10-01-preview/environments.json#L113 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Environments' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DevCenter/preview/2023-10-01-preview/environments.json#L62 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'DevBoxes' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L564 |
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.DevCenter/preview/2023-10-01-preview/environments.json#L1483 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.DevCenter/preview/2023-10-01-preview/environments.json#L1479 |
|
| Schema with type: number should specify format Location: Microsoft.DevCenter/preview/2023-10-01-preview/environments.json#L335 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.DevCenter/preview/2023-10-01-preview/devcenter.json#L260 |
|
| Error response should contain a x-ms-error-code header. Location: Microsoft.DevCenter/preview/2023-10-01-preview/devcenter.json#L108 |
|
| Error response should contain a x-ms-error-code header. Location: Microsoft.DevCenter/preview/2023-10-01-preview/devcenter.json#L69 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L3098 |
|
| Schema name should be Pascal case. Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L2210 |
|
| Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L1481 |
|
| Schema with type: number should specify format Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L973 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L945 |
|
| Schema with type: number should specify format Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L915 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L887 |
|
| Schema with type: number should specify format Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L857 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L826 |
|
| Schema with type: number should specify format Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L796 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L768 |
|
| Schema with type: number should specify format Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L735 |
|
| OperationId for put method should contain both 'Create' and 'Update' Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L671 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L264 |
Loading