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

[Hub Generated] Review request for Microsoft.Security to add version stable/2024-01-01 #24625

Merged
merged 71 commits into from
Dec 13, 2023

...

3d1d070
Select commit
Loading
Failed to load commit list.
Merged

[Hub Generated] Review request for Microsoft.Security to add version stable/2024-01-01 #24625

...
3d1d070
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff completed Dec 12, 2023 in 2m 30s

Swagger LintDiff failed

LintDiff: 12 Errors, 9 Warnings
The check status is neutral due to the check was suppressed by label Approved-LintDiff
.View build log for more details.

Details

compared tags (via openapi-validator v2.1.6) new version base version
package-composite-v3 package-composite-v3(3d1d070) package-composite-v3(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
❌ ResourceNameRestriction The resource name parameter 'pricingName' should be defined with a 'pattern' restriction.
Location: Microsoft.Security/stable/2024-01-01/pricings.json#L37		 RPC-Uri-V1-05
❌ RequestBodyMustExistForPutPatch The put or patch operation does not have a request body defined. This is not allowed. Please specify a request body for this operation.
Location: Microsoft.Security/stable/2024-01-01/pricings.json#L110		 RPC-Put-V1-28, RPC-Patch-V1-12
❌ XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.Security/stable/2024-01-01/pricings.json#L184		 RPC-Get-V1-13
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.Security/stable/2024-01-01/pricings.json#L215
⚠️ RequiredReadOnlySystemData The response of operation:'Pricings_Get' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Security/stable/2024-01-01/pricings.json#L38
⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
Location: Microsoft.Security/stable/2024-01-01/pricings.json#L64
⚠️ RequiredReadOnlySystemData The response of operation:'Pricings_Update' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Security/stable/2024-01-01/pricings.json#L90
⚠️ PutInOperationName 'PUT' operation 'Pricings_Update' 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.Security/stable/2024-01-01/pricings.json#L109
⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
Location: Microsoft.Security/stable/2024-01-01/pricings.json#L110
⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
Location: Microsoft.Security/stable/2024-01-01/pricings.json#L156
⚠️ PageableOperation Based on the response model schema, operation 'Pricings_List' might be pageable. Consider adding the x-ms-pageable extension.
Location: Microsoft.Security/stable/2024-01-01/pricings.json#L184
⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
Location: Microsoft.Security/stable/2024-01-01/pricings.json#L201


The following errors/warnings exist before current PR submission:

Rule Message
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.Security/stable/2024-01-01/pricings.json#L240
❌ PropertiesTypeObjectNoDefinition Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience.
Location: Microsoft.Security/stable/2024-01-01/pricings.json#L240
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.Security/stable/2024-01-01/pricings.json#L250
❌ PropertiesTypeObjectNoDefinition Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience.
Location: Microsoft.Security/stable/2024-01-01/pricings.json#L250
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.Security/stable/2024-01-01/pricings.json#L384
❌ PropertiesTypeObjectNoDefinition Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience.
Location: Microsoft.Security/stable/2024-01-01/pricings.json#L384
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.Security/stable/2024-01-01/pricings.json#L438
❌ PropertiesTypeObjectNoDefinition Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience.
Location: Microsoft.Security/stable/2024-01-01/pricings.json#L438
⚠️ 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.Security/stable/2024-01-01/pricings.json#L390
View more details on openapi-pipeline-app