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

Jump to bottom

Azure Event Grid: New features for 2023-12-15-preview API version #26225

Merged
merged 21 commits into from
Oct 30, 2023

trigger tasks

13e4ad1
Select commit
Loading
Failed to load commit list.
Merged

Azure Event Grid: New features for 2023-12-15-preview API version #26225

trigger tasks
13e4ad1
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff succeeded Oct 27, 2023 in 3m 17s

Swagger LintDiff succeeded

LintDiff
View more details.

Details

compared tags (via openapi-validator v2.1.6) new version base version
package-2023-12-preview package-2023-12-preview(13e4ad1) default(main)

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

Rule Message Related RPC [For API reviewers]
⚠️ ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L2737
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L2748
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L2748
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L2748
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L2803
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L9110
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L9110
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L9110
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L9174
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L9197
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L9197
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L9197
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L9269
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L9296
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L9296
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L9296
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L9346
⚠️ LocationMustHaveXmsMutability Property location must have 'x-ms-mutability':['read', 'create'] extension defined.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L16196		 RPC-Put-V1-14
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L17253
⚠️ 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.EventGrid/preview/2023-12-15-preview/EventGrid.json#L17259


The following errors/warnings exist before current PR submission:
Only 50 items are listed, please refer to log for more details.

Rule Message
❌ 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.EventGrid/preview/2023-12-15-preview/EventGrid.json#L173
❌ PutGetPatchResponseSchema /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels/{channelName} has different responses for PUT/GET/PATCH operations. The PUT/GET/PATCH operations must have same schema response.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L319
❌ ResourceNameRestriction The resource name parameter 'partnerNamespaceName' should be defined with a 'pattern' restriction.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L319
❌ ResourceNameRestriction The resource name parameter 'channelName' should be defined with a 'pattern' restriction.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L319
❌ DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L367
❌ DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L441
❌ 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.EventGrid/preview/2023-12-15-preview/EventGrid.json#L451
❌ DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L506
❌ DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L572
❌ ResourceNameRestriction The resource name parameter 'partnerNamespaceName' should be defined with a 'pattern' restriction.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L583
❌ DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L630
❌ ResourceNameRestriction The resource name parameter 'partnerNamespaceName' should be defined with a 'pattern' restriction.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L644
❌ ResourceNameRestriction The resource name parameter 'channelName' should be defined with a 'pattern' restriction.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L644
❌ DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L692
❌ 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.EventGrid/preview/2023-12-15-preview/EventGrid.json#L857
❌ 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.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1157
❌ PutGetPatchResponseSchema /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName} has different responses for PUT/GET/PATCH operations. The PUT/GET/PATCH operations must have same schema response.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1303
❌ ResourceNameRestriction The resource name parameter 'domainName' should be defined with a 'pattern' restriction.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1303
❌ DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1344
❌ ProvisioningStateSpecifiedForLROPut 200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1354
❌ 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.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1354
❌ DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1405
❌ 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.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1416
❌ DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1464
❌ PatchResponseCodes Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1475
❌ LroPatch202 The async patch operation should return 202.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1519
❌ ProvisioningStateSpecifiedForLROPatch 200 response schema in long running PATCH operation is missing ProvisioningState property. A LRO PATCH operations 200 response schema must have ProvisioningState specified.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1520
❌ DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1529
❌ DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1574
❌ DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1628
❌ ResourceNameRestriction The resource name parameter 'domainName' should be defined with a 'pattern' restriction.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1642
❌ DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1683
❌ ResourceNameRestriction The resource name parameter 'domainName' should be defined with a 'pattern' restriction.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1694
❌ DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1746
❌ ResourceNameRestriction The resource name parameter 'domainName' should be defined with a 'pattern' restriction.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1757
❌ ResourceNameRestriction The resource name parameter 'domainTopicName' should be defined with a 'pattern' restriction.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1757
❌ DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1805
❌ ProvisioningStateSpecifiedForLROPut 200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1815
❌ 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.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1815
❌ DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1862
❌ 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.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1873
❌ DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1928
❌ ResourceNameRestriction The resource name parameter 'domainName' should be defined with a 'pattern' restriction.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1940
❌ DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L1987
❌ ResourceNameRestriction The resource name parameter 'domainName' should be defined with a 'pattern' restriction.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L2001
❌ ResourceNameRestriction The resource name parameter 'topicName' should be defined with a 'pattern' restriction.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L2001
❌ ResourceNameRestriction The resource name parameter 'eventSubscriptionName' should be defined with a 'pattern' restriction.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L2001
❌ DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L2056
❌ ResourceNameRestriction The resource name parameter 'topicName' should be defined with a 'pattern' restriction.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L2067
❌ ResourceNameRestriction The resource name parameter 'eventSubscriptionName' should be defined with a 'pattern' restriction.
Location: Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json#L2067
View more details on openapi-pipeline-app