Skip to content
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.

Sign up for GitHub

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

[DevCenter] Add 2023-10-01-preview dataplane API version #26049

Merged
merged 18 commits into from
Oct 26, 2023

Enum

88881ce
Select commit
Loading
Failed to load commit list.
Merged

[DevCenter] Add 2023-10-01-preview dataplane API version #26049

Enum
88881ce
Select commit
Loading
Failed to load commit list.
This check has been archived and is scheduled for deletion. Learn more about checks retention
openapi-pipeline-app / Swagger LintDiff completed Oct 18, 2023 in 2m 54s

Swagger LintDiff failed

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 v2.1.6) 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]
❌ OperationIdNounVerb 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
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L322
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L374
⚠️ LongRunningOperationsOptionsValidator 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
⚠️ LroHeaders A 202 response should include an Operation-Location response header.
Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L417
⚠️ SchemaTypeAndFormat Schema with type: number should specify format
Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L419
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L423
⚠️ EnumInsteadOfBoolean 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
⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
Location: Microsoft.DevCenter/preview/2023-10-01-preview/environments.json#L264
⚠️ OperationId OperationId for patch method should contain 'Update'
Location: Microsoft.DevCenter/preview/2023-10-01-preview/environments.json#L284
⚠️ PatchInOperationName '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
⚠️ EnumInsteadOfBoolean 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


The following errors/warnings exist before current PR submission:

Rule Message
❌ OperationIdNounVerb 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
❌ OperationIdNounVerb 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
❌ OperationIdNounVerb 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
❌ OperationIdNounVerb 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
❌ OperationIdNounVerb 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
❌ OperationIdNounVerb 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
❌ OperationIdNounVerb 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
❌ OperationIdNounVerb 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
❌ OperationIdNounVerb 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
❌ OperationIdNounVerb 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
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L264
⚠️ OperationId OperationId for put method should contain both 'Create' and 'Update'
Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L671
⚠️ SchemaTypeAndFormat Schema with type: number should specify format
Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L735
⚠️ LongRunningOperationsOptionsValidator 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
⚠️ SchemaTypeAndFormat Schema with type: number should specify format
Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L796
⚠️ LongRunningOperationsOptionsValidator 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
⚠️ SchemaTypeAndFormat Schema with type: number should specify format
Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L857
⚠️ LongRunningOperationsOptionsValidator 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
⚠️ SchemaTypeAndFormat Schema with type: number should specify format
Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L915
⚠️ LongRunningOperationsOptionsValidator 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
⚠️ SchemaTypeAndFormat Schema with type: number should specify format
Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L973
⚠️ ListInOperationName 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
⚠️ SchemaNamesConvention Schema name should be Pascal case.
Location: Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json#L2210
⚠️ EnumInsteadOfBoolean 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
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Microsoft.DevCenter/preview/2023-10-01-preview/devcenter.json#L69
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Microsoft.DevCenter/preview/2023-10-01-preview/devcenter.json#L108
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.DevCenter/preview/2023-10-01-preview/devcenter.json#L260
⚠️ SchemaTypeAndFormat Schema with type: number should specify format
Location: Microsoft.DevCenter/preview/2023-10-01-preview/environments.json#L335
⚠️ EnumInsteadOfBoolean 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
⚠️ EnumInsteadOfBoolean 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
View more details on openapi-pipeline-app