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

add stable API 2024-02-01 for GA #27360

Merged
merged 5 commits into from
Jan 29, 2024

fix Swagger Avocado check

20c63d6
Select commit
Loading
Failed to load commit list.
Merged

add stable API 2024-02-01 for GA #27360

fix Swagger Avocado check
20c63d6
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff succeeded Jan 22, 2024 in 4m 6s

Swagger LintDiff succeeded

LintDiff
View Azure DevOps build log for more details.

Details

compared tags (via openapi-validator v2.1.6) new version base version
package-2024-02-01 package-2024-02-01(20c63d6) default(main)

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/stable/2024-02-01/devbox.json#L421
❌ 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/stable/2024-02-01/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/stable/2024-02-01/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/stable/2024-02-01/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/stable/2024-02-01/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/stable/2024-02-01/environments.json#L287
❌ 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/stable/2024-02-01/environments.json#L333
❌ 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/stable/2024-02-01/environments.json#L899
❌ 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/stable/2024-02-01/environments.json#L950
❌ 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/stable/2024-02-01/environments.json#L1001
❌ 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/stable/2024-02-01/environments.json#L1046
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.DevCenter/stable/2024-02-01/devbox.json#L264
⚠️ OperationId OperationId for put method should contain both 'Create' and 'Update'
Location: Microsoft.DevCenter/stable/2024-02-01/devbox.json#L528
⚠️ SchemaTypeAndFormat Schema with type: number should specify format
Location: Microsoft.DevCenter/stable/2024-02-01/devbox.json#L592
⚠️ LongRunningOperationsOptionsValidator A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled.
Location: Microsoft.DevCenter/stable/2024-02-01/devbox.json#L625
⚠️ SchemaTypeAndFormat Schema with type: number should specify format
Location: Microsoft.DevCenter/stable/2024-02-01/devbox.json#L653
⚠️ LongRunningOperationsOptionsValidator A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled.
Location: Microsoft.DevCenter/stable/2024-02-01/devbox.json#L683
⚠️ SchemaTypeAndFormat Schema with type: number should specify format
Location: Microsoft.DevCenter/stable/2024-02-01/devbox.json#L714
⚠️ LongRunningOperationsOptionsValidator A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled.
Location: Microsoft.DevCenter/stable/2024-02-01/devbox.json#L744
⚠️ SchemaTypeAndFormat Schema with type: number should specify format
Location: Microsoft.DevCenter/stable/2024-02-01/devbox.json#L772
⚠️ LongRunningOperationsOptionsValidator A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled.
Location: Microsoft.DevCenter/stable/2024-02-01/devbox.json#L802
⚠️ SchemaTypeAndFormat Schema with type: number should specify format
Location: Microsoft.DevCenter/stable/2024-02-01/devbox.json#L830
⚠️ ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
Location: Microsoft.DevCenter/stable/2024-02-01/devbox.json#L1114
⚠️ SchemaNamesConvention Schema name should be Pascal case.
Location: Microsoft.DevCenter/stable/2024-02-01/devbox.json#L1746
⚠️ 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/stable/2024-02-01/devbox.json#L2330
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Microsoft.DevCenter/stable/2024-02-01/devcenter.json#L69
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Microsoft.DevCenter/stable/2024-02-01/devcenter.json#L108
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.DevCenter/stable/2024-02-01/devcenter.json#L260
⚠️ OperationId OperationId for patch method should contain 'Update'
Location: Microsoft.DevCenter/stable/2024-02-01/environments.json#L287
⚠️ 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/stable/2024-02-01/environments.json#L287
⚠️ SchemaTypeAndFormat Schema with type: number should specify format
Location: Microsoft.DevCenter/stable/2024-02-01/environments.json#L338
⚠️ 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/stable/2024-02-01/environments.json#L1233
⚠️ 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/stable/2024-02-01/environments.json#L1482
⚠️ 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/stable/2024-02-01/environments.json#L1486
View more details on openapi-pipeline-app