From b12d3e7151459f605c762e5629f8b176a1788fe8 Mon Sep 17 00:00:00 2001 From: Ashraf Hamad Date: Sat, 9 May 2020 05:50:50 -0700 Subject: [PATCH 1/4] Update 2020-04-01-preview swagger to include new properties per customer's feedback --- .../preview/2020-04-01-preview/EventGrid.json | 71 +++++++++++++------ 1 file changed, 50 insertions(+), 21 deletions(-) diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-04-01-preview/EventGrid.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-04-01-preview/EventGrid.json index 4c189d18d19f..2ea767780617 100644 --- a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-04-01-preview/EventGrid.json +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-04-01-preview/EventGrid.json @@ -5378,7 +5378,7 @@ "type": "object", "properties": { "name": { - "description": "the Sku name of the resource.\r\nthe possible values: Basic; Premium", + "description": "The Sku name of the resource. The possible values are: Basic or Premium.", "enum": [ "Basic", "Premium" @@ -5896,9 +5896,32 @@ "modelAsString": true } }, + "partnerTopicReadinessState": { + "description": "The readiness state of the corresponding partner topic.", + "enum": [ + "NotActivatedByUserYet", + "ActivatedByUser", + "DeactivatedByUser", + "DeletedByUser" + ], + "type": "string", + "x-ms-enum": { + "name": "PartnerTopicReadinessState", + "modelAsString": true + } + }, + "expirationTimeIfNotActivatedUtc": { + "format": "date-time", + "description": "Expiration time of the event channel. If this timer expires while the corresponding partner topic is never actived,\r\nthe event channel and corresponding partner topic are deleted.", + "type": "string" + }, "filter": { "$ref": "#/definitions/EventChannelFilter", "description": "Information about the filter for the event channel." + }, + "partnerTopicFriendlyDescription": { + "description": "Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic.\r\nThis will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer.", + "type": "string" } } }, @@ -5934,25 +5957,6 @@ "description": "Filter for the Event Channel.", "type": "object", "properties": { - "subjectBeginsWith": { - "description": "An optional string to filter events for an event channel based on a resource path prefix.\r\nThe format of this depends on the publisher of the events. Wildcard characters are not supported in this path.", - "type": "string" - }, - "subjectEndsWith": { - "description": "An optional string to filter events for an event channel based on a resource path suffix.\r\nWildcard characters are not supported in this path.", - "type": "string" - }, - "includedEventTypes": { - "description": "A list of applicable event types that need to be part of the event channel. If it is desired to subscribe to all default event types, set the IncludedEventTypes to null.", - "type": "array", - "items": { - "type": "string" - } - }, - "isSubjectCaseSensitive": { - "description": "Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter\r\nshould be compared in a case sensitive manner.", - "type": "boolean" - }, "advancedFilters": { "description": "An array of advanced filters that are used for filtering event channels.", "type": "array", @@ -7027,7 +7031,23 @@ "type": "string" }, "partnerResourceTypeDescription": { - "description": "Description of the partner resource type.", + "description": "Short description of the partner resource type. The length of this description should not exceed 256 characters.", + "type": "string" + }, + "longDescription": { + "description": "Long description for the custom scenarios and integration to be displayed in the portal if needed.\r\nLength of this description should not exceed 2048 characters.", + "type": "string" + }, + "partnerCustomerServiceNumber": { + "description": "The customer service number of the publisher. The expected phone format should start with a '+' sign \r\nfollowed by the country code. The remaining digits are then followed. Only digits and spaces are allowed and its\r\nlength cannot exceed 16 digits including country code. Examples of valid phone numbers are: +1 515 123 4567 and\r\n+966 7 5115 2471. Examples of invalid phone numbers are: +1 (515) 123-4567, 1 515 123 4567 and +966 121 5115 24 7 551 1234 43", + "type": "string" + }, + "partnerCustomerServiceExtension": { + "description": "The extension of the customer service number of the publisher. Only digits are allowed and number of digits should not exceed 10.", + "type": "string" + }, + "customerServiceUri": { + "description": "The extension of the customer service URI of the publisher.", "type": "string" }, "setupUri": { @@ -7209,6 +7229,11 @@ "description": "Source associated with this partner topic. This represents a unique partner resource.", "type": "string" }, + "expirationTimeIfNotActivatedUtc": { + "format": "date-time", + "description": "Expiration time of the partner topic. If this timer expires while the partner topic is still never actived,\r\nthe partner topic and corresponding event channel are deleted.", + "type": "string" + }, "provisioningState": { "description": "Provisioning state of the partner topic.", "enum": [ @@ -7238,6 +7263,10 @@ "name": "PartnerTopicActivationState", "modelAsString": true } + }, + "partnerTopicFriendlyDescription": { + "description": "Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic.\r\nThis will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer.", + "type": "string" } } }, From 83ad49328c2b33907bca26231f1e2c1497b75b04 Mon Sep 17 00:00:00 2001 From: Ashraf Hamad Date: Sat, 9 May 2020 06:20:19 -0700 Subject: [PATCH 2/4] fix spelling --- .../preview/2020-04-01-preview/EventGrid.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-04-01-preview/EventGrid.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-04-01-preview/EventGrid.json index 2ea767780617..ff3ea228fd7c 100644 --- a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-04-01-preview/EventGrid.json +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-04-01-preview/EventGrid.json @@ -5912,7 +5912,7 @@ }, "expirationTimeIfNotActivatedUtc": { "format": "date-time", - "description": "Expiration time of the event channel. If this timer expires while the corresponding partner topic is never actived,\r\nthe event channel and corresponding partner topic are deleted.", + "description": "Expiration time of the event channel. If this timer expires while the corresponding partner topic is never activated,\r\nthe event channel and corresponding partner topic are deleted.", "type": "string" }, "filter": { @@ -7231,7 +7231,7 @@ }, "expirationTimeIfNotActivatedUtc": { "format": "date-time", - "description": "Expiration time of the partner topic. If this timer expires while the partner topic is still never actived,\r\nthe partner topic and corresponding event channel are deleted.", + "description": "Expiration time of the partner topic. If this timer expires while the partner topic is still never activated,\r\nthe partner topic and corresponding event channel are deleted.", "type": "string" }, "provisioningState": { From 7a0ae9eee9154bcedf85efc60277c83850ce0d31 Mon Sep 17 00:00:00 2001 From: Ashraf Hamad Date: Tue, 12 May 2020 05:59:52 -0700 Subject: [PATCH 3/4] add readonly flag for readiness state --- .../preview/2020-04-01-preview/EventGrid.json | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-04-01-preview/EventGrid.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-04-01-preview/EventGrid.json index ff3ea228fd7c..c90e9c427420 100644 --- a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-04-01-preview/EventGrid.json +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-04-01-preview/EventGrid.json @@ -5905,6 +5905,7 @@ "DeletedByUser" ], "type": "string", + "readOnly": true, "x-ms-enum": { "name": "PartnerTopicReadinessState", "modelAsString": true From 835890299e9c1aa4e937d885122919c49897fcca Mon Sep 17 00:00:00 2001 From: Ashraf Hamad Date: Tue, 12 May 2020 18:00:21 -0700 Subject: [PATCH 4/4] fix prettier --- .../preview/2020-04-01-preview/EventGrid.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-04-01-preview/EventGrid.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-04-01-preview/EventGrid.json index c90e9c427420..407f89526a45 100644 --- a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-04-01-preview/EventGrid.json +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-04-01-preview/EventGrid.json @@ -5905,7 +5905,7 @@ "DeletedByUser" ], "type": "string", - "readOnly": true, + "readOnly": true, "x-ms-enum": { "name": "PartnerTopicReadinessState", "modelAsString": true