Feature/cplat 2023 09 01 #26270
Merged
Feature/cplat 2023 09 01 #26270
openapi-pipeline-app / Swagger LintDiff
succeeded
Dec 1, 2023 in 4m 9s
Swagger LintDiff succeeded
LintDiff
View more details.
Details
compared tags (via openapi-validator v2.1.6) | new version | base version |
---|---|---|
package-2023-09-01 | package-2023-09-01(5d17c45) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
Schema should have a description or title. Location: ComputeRP/stable/2023-09-01/capacityReservation.json#L747 |
||
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: ComputeRP/stable/2023-09-01/computeRPCommon.json#L1106 |
||
Not using the common-types defined parameter 'resourceGroupName'. Location: ComputeRP/stable/2023-09-01/dedicatedHost.json#L767 |
||
Not using the common-types defined parameter 'resourceGroupName'. Location: ComputeRP/stable/2023-09-01/virtualMachine.json#L1946 |
||
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: ComputeRP/stable/2023-09-01/virtualMachine.json#L3188 |
||
Not using the common-types defined parameter 'resourceGroupName'. Location: ComputeRP/stable/2023-09-01/virtualMachineScaleSet.json#L1812 |
||
Not using the common-types defined parameter 'resourceGroupName'. Location: ComputeRP/stable/2023-09-01/virtualMachineScaleSet.json#L2764 |
||
Not using the common-types defined parameter 'resourceGroupName'. Location: ComputeRP/stable/2023-09-01/virtualMachineScaleSet.json#L3685 |
||
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: ComputeRP/stable/2023-09-01/virtualMachineScaleSet.json#L3881 |
||
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: ComputeRP/stable/2023-09-01/virtualMachineScaleSet.json#L3931 |
||
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: ComputeRP/stable/2023-09-01/virtualMachineScaleSet.json#L3941 |
The following errors/warnings exist before current PR submission:
Only 50 items are listed, please refer to log for more details.
Rule | Message |
---|---|
ResourceNameRestriction |
The resource name parameter 'availabilitySetName' should be defined with a 'pattern' restriction. Location: ComputeRP/stable/2023-09-01/availabilitySet.json#L37 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: ComputeRP/stable/2023-09-01/availabilitySet.json#L38 |
ResourceNameRestriction |
The resource name parameter 'availabilitySetName' should be defined with a 'pattern' restriction. Location: ComputeRP/stable/2023-09-01/availabilitySet.json#L353 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: ComputeRP/stable/2023-09-01/availabilitySet.json#L385 |
MissingTypeObject |
The schema 'AvailabilitySetProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/availabilitySet.json#L411 |
MissingTypeObject |
The schema 'AvailabilitySet' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/availabilitySet.json#L458 |
MissingTypeObject |
The schema 'AvailabilitySetUpdate' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/availabilitySet.json#L476 |
MissingTypeObject |
The schema 'AvailabilitySetListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/availabilitySet.json#L494 |
ResourceNameRestriction |
The resource name parameter 'capacityReservationGroupName' should be defined with a 'pattern' restriction. Location: ComputeRP/stable/2023-09-01/capacityReservation.json#L37 |
ParametersInPointGet |
Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version. Location: ComputeRP/stable/2023-09-01/capacityReservation.json#L218 |
ResourceNameRestriction |
The resource name parameter 'capacityReservationGroupName' should be defined with a 'pattern' restriction. Location: ComputeRP/stable/2023-09-01/capacityReservation.json#L390 |
ResourceNameRestriction |
The resource name parameter 'capacityReservationName' should be defined with a 'pattern' restriction. Location: ComputeRP/stable/2023-09-01/capacityReservation.json#L390 |
LroLocationHeader |
A 202 response should include an Location response header. Location: ComputeRP/stable/2023-09-01/capacityReservation.json#L513 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: ComputeRP/stable/2023-09-01/capacityReservation.json#L533 |
LroLocationHeader |
A 202 response should include an Location response header. Location: ComputeRP/stable/2023-09-01/capacityReservation.json#L572 |
ParametersInPointGet |
Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version. Location: ComputeRP/stable/2023-09-01/capacityReservation.json#L601 |
ResourceNameRestriction |
The resource name parameter 'capacityReservationGroupName' should be defined with a 'pattern' restriction. Location: ComputeRP/stable/2023-09-01/capacityReservation.json#L665 |
OperationIdNounVerb |
Per the Noun_Verb convention for Operation Ids, the noun 'CapacityReservations' 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: ComputeRP/stable/2023-09-01/capacityReservation.json#L670 |
GetCollectionResponseSchema |
The response in the GET collection operation 'VirtualMachineRunCommands_List' does not match the response definition in the individual GET operation 'VirtualMachineRunCommands_Get' . Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L36 |
OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.Compute/operations' does not match the ARM specification. Please standardize the schema. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L52 |
OperationsApiSchemaUsesCommonTypes |
Operations API path must follow the schema provided in the common types. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L53 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L152 |
MissingTypeObject |
The schema 'ComputeOperationListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L178 |
MissingTypeObject |
The schema 'ComputeOperationValue' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L194 |
MissingTypeObject |
The schema 'ComputeOperationValueDisplay' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L213 |
MissingTypeObject |
The schema 'UsageName' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L238 |
MissingTypeObject |
The schema 'Usage' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L251 |
MissingTypeObject |
The schema 'ListUsagesResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L287 |
MissingTypeObject |
The schema 'SubResourceWithColocationStatus' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L355 |
MissingTypeObject |
The schema 'VirtualMachineSize' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L369 |
MissingTypeObject |
The schema 'VirtualMachineSizeListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L403 |
MissingTypeObject |
The schema 'Plan' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L418 |
MissingTypeObject |
The schema 'HardwareProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L439 |
MissingTypeObject |
The schema 'ImageReference' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L640 |
MissingTypeObject |
The schema 'KeyVaultSecretReference' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L691 |
MissingTypeObject |
The schema 'KeyVaultKeyReference' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L717 |
MissingTypeObject |
The schema 'DiskEncryptionSettings' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L734 |
MissingTypeObject |
The schema 'VirtualHardDisk' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L774 |
MissingTypeObject |
The schema 'DiffDiskSettings' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L872 |
MissingTypeObject |
The schema 'ManagedDiskParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L885 |
MissingTypeObject |
The schema 'OSDisk' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L907 |
MissingTypeObject |
The schema 'DataDisk' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L972 |
MissingTypeObject |
The schema 'StorageProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L1053 |
MissingTypeObject |
The schema 'UefiSettings' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L1080 |
MissingTypeObject |
The schema 'SecurityProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L1130 |
MissingTypeObject |
The schema 'AdditionalCapabilities' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L1213 |
MissingTypeObject |
The schema 'AdditionalUnattendContent' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L1226 |
MissingTypeObject |
The schema 'WinRMListener' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L1269 |
MissingTypeObject |
The schema 'WinRMConfiguration' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L1290 |
MissingTypeObject |
The schema 'WindowsConfiguration' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-09-01/computeRPCommon.json#L1303 |
Loading