EventHub 2024-05-01-preview #28450
Merged
EventHub 2024-05-01-preview #28450
openapi-pipeline-app / ~[NotRequired_Staging] Swagger LintDiff
succeeded
Apr 11, 2024 in 4m 7s
~[NotRequired_Staging] Swagger LintDiff succeeded
ppe/LintDiff
View Azure DevOps build log for more details.
Details
compared tags (via openapi-validator vbeta) | new version | base version |
---|---|---|
package-2024-05-preview | package-2024-05-preview(1954910) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/preview/2024-05-01-preview/quotaConfiguration-preview.json#L104 |
||
The response of operation:'Configuration_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.EventHub/preview/2024-05-01-preview/quotaConfiguration-preview.json#L99 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/preview/2024-05-01-preview/quotaConfiguration-preview.json#L43 |
||
'PATCH' operation 'Configuration_Patch' 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.EventHub/preview/2024-05-01-preview/quotaConfiguration-preview.json#L42 |
||
The response of operation:'Configuration_Patch' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.EventHub/preview/2024-05-01-preview/quotaConfiguration-preview.json#L38 |
||
A nested resource type's List operation must include all the parent segments in its api path. Location: Microsoft.EventHub/preview/2024-05-01-preview/quotaConfiguration-preview.json#L37 |
RPC-Get-V1-11 | |
Missing identifier id in array item property Location: Microsoft.EventHub/preview/2024-05-01-preview/networkrulessets-preview.json#L245 |
||
Missing identifier id in array item property Location: Microsoft.EventHub/preview/2024-05-01-preview/networkrulessets-preview.json#L238 |
||
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.EventHub/preview/2024-05-01-preview/networkrulessets-preview.json#L222 |
||
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.EventHub/preview/2024-05-01-preview/networkrulessets-preview.json#L209 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/preview/2024-05-01-preview/networkrulessets-preview.json#L140 |
||
Based on the response model schema, operation 'Namespaces_ListNetworkRuleSet' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.EventHub/preview/2024-05-01-preview/networkrulessets-preview.json#L129 |
||
A nested resource type's List operation must include all the parent segments in its api path. Location: Microsoft.EventHub/preview/2024-05-01-preview/networkrulessets-preview.json#L128 |
RPC-Get-V1-11 | |
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/preview/2024-05-01-preview/networkrulessets-preview.json#L98 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/preview/2024-05-01-preview/networkrulessets-preview.json#L49 |
||
The service-defined (reserved name) resource 'default' should be represented as a path parameter enum with modelAsString set to true .Location: Microsoft.EventHub/preview/2024-05-01-preview/networkrulessets-preview.json#L37 |
RPC-ConstrainedCollections-V1-04 | |
Schema should have a description or title. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L998 |
||
Schema should have a description or title. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L989 |
||
Use the latest version v5 of types.json. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L385 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L345 |
||
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.EventHub/preview/2024-05-01-preview/Clusters-preview.json#L424 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/preview/2024-05-01-preview/Clusters-preview.json#L331 |
||
Based on the response model schema, operation 'Clusters_ListNamespaces' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.EventHub/preview/2024-05-01-preview/Clusters-preview.json#L326 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/preview/2024-05-01-preview/Clusters-preview.json#L291 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/preview/2024-05-01-preview/Clusters-preview.json#L232 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/preview/2024-05-01-preview/Clusters-preview.json#L170 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/preview/2024-05-01-preview/Clusters-preview.json#L130 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/preview/2024-05-01-preview/Clusters-preview.json#L88 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/preview/2024-05-01-preview/Clusters-preview.json#L49 |
||
Property location must have 'x-ms-mutability':['read', 'create'] extension defined.Location: Microsoft.EventHub/preview/2024-05-01-preview/AvailableClusterRegions-preview.json#L91 |
RPC-Put-V1-14 | |
Missing identifier id in array item property Location: Microsoft.EventHub/preview/2024-05-01-preview/AvailableClusterRegions-preview.json#L78 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/preview/2024-05-01-preview/AvailableClusterRegions-preview.json#L49 |
||
Based on the response model schema, operation 'Clusters_ListAvailableClusterRegion' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.EventHub/preview/2024-05-01-preview/AvailableClusterRegions-preview.json#L38 |
The following errors/warnings exist before current PR submission:
Only 50 items are listed, please refer to log for more details.
Rule | Message |
---|---|
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.EventHub/preview/2024-05-01-preview/SchemaRegistry.json#L310 |
SystemDataDefinitionsCommonTypes |
System data references must utilize common types. Location: Microsoft.EventHub/preview/2024-05-01-preview/SchemaRegistry.json#L295 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.EventHub/preview/2024-05-01-preview/SchemaRegistry.json#L255 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.EventHub/preview/2024-05-01-preview/SchemaRegistry.json#L251 |
TrackedResourcePatchOperation |
Tracked resource 'SchemaGroup' must have patch operation that at least supports the update of tags. Location: Microsoft.EventHub/preview/2024-05-01-preview/SchemaRegistry.json#L230 |
RequestSchemaForTrackedResourcesMustHaveTags |
A tracked resource MUST always have tags as a top level optional property. Tracked resource does not have tags in the request schema. Location: Microsoft.EventHub/preview/2024-05-01-preview/SchemaRegistry.json#L89 |
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: Microsoft.EventHub/preview/2024-05-01-preview/SchemaRegistry.json#L89 |
ResourceNameRestriction |
The resource name parameter 'schemaGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.EventHub/preview/2024-05-01-preview/SchemaRegistry.json#L88 |
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.EventHub/preview/2024-05-01-preview/operations.json#L114 |
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.EventHub/preview/2024-05-01-preview/operations.json#L82 |
MissingTypeObject |
The schema 'OperationListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2024-05-01-preview/operations.json#L75 |
OperationsApiSchemaUsesCommonTypes |
Operations API path must follow the schema provided in the common types. Location: Microsoft.EventHub/preview/2024-05-01-preview/operations.json#L58 |
MissingTypeObject |
The schema 'PrivateLinkResourcesListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L1262 |
MissingTypeObject |
The schema 'PrivateLinkResourceProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L1239 |
MissingTypeObject |
The schema 'PrivateLinkResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L1217 |
MissingTypeObject |
The schema 'PrivateEndpointConnectionListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L1201 |
MissingTypeObject |
The schema 'ConnectionState' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L1178 |
MissingTypeObject |
The schema 'PrivateEndpoint' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L1169 |
MissingTypeObject |
The schema 'PrivateEndpointConnectionProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L1140 |
SystemDataDefinitionsCommonTypes |
System data references must utilize common types. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L1136 |
TrackedResourcePatchOperation |
Tracked resource 'PrivateEndpointConnection' must have patch operation that at least supports the update of tags. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L1120 |
MissingTypeObject |
The schema 'PrivateEndpointConnection' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L1120 |
MissingTypeObject |
The schema 'KeyVaultProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L1097 |
MissingTypeObject |
The schema 'Encryption' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L1067 |
MissingTypeObject |
The schema 'Identity' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L1012 |
MissingTypeObject |
The schema 'properties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L780 |
SystemDataDefinitionsCommonTypes |
System data references must utilize common types. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L778 |
MissingTypeObject |
The schema 'EHNamespace' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L765 |
MissingTypeObject |
The schema 'EHNamespaceListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L749 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L737 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L731 |
PostResponseCodes |
200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L699 |
ResourceNameRestriction |
The resource name parameter 'resourceAssociationName' should be defined with a 'pattern' restriction. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L698 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L685 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L657 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L612 |
ProvisioningStateMustBeReadOnly |
provisioningState property must be set to readOnly. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L598 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L555 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L546 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L511 |
ProvisioningStateMustBeReadOnly |
provisioningState property must be set to readOnly. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L499 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L497 |
ProvisioningStateMustBeReadOnly |
provisioningState property must be set to readOnly. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L493 |
ProvisioningStateMustBeReadOnly |
provisioningState property must be set to readOnly. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L487 |
RequestSchemaForTrackedResourcesMustHaveTags |
A tracked resource MUST always have tags as a top level optional property. Tracked resource does not have tags in the request schema. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L444 |
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: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L444 |
LroExtension |
Operations with a 202 response must specify x-ms-long-running-operation: true . GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L444 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L321 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:name. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L296 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not have default value, property:keySource. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L296 |
Loading