From 554d6b6e5e2e646849d38c8fd1d6557410f85acb Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 9 Dec 2024 17:33:06 +0100 Subject: [PATCH 01/10] Add enum value for `terminationReason` attribut Add enum value for `terminationReason` attribut --- documentation/API-design-guidelines.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/documentation/API-design-guidelines.md b/documentation/API-design-guidelines.md index 7f67515d..177d5d0f 100644 --- a/documentation/API-design-guidelines.md +++ b/documentation/API-design-guidelines.md @@ -1956,9 +1956,21 @@ Note: For operational and troubleshooting purposes it is relevant to accommodate #### subscription-ends event Specific event notification type "subscription-ends" is defined to inform listener about subscription termination. -It is used when the `subscriptionExpireTime` or `subscriptionMaxEvents` has been reached, or, if the API server has to stop sending notifications prematurely, or if the subscription request is managed asynchronously by the server and it is not able to provide the service. For this specific event, the `data` must feature `terminationReason` attribute. An enumeration of `terminationReason` is provided in event-subscription-template.yaml (see in [Commonalities/artifacts/camara-cloudevents](/artifacts/camara-cloudevents) directory ``event-subscription-template.yaml``). +It is used when the `subscriptionExpireTime` or `subscriptionMaxEvents` has been reached, or, if the API server has to stop sending notifications prematurely, or if the subscription request is managed asynchronously by the server and it is not able to provide the service. For this specific event, the `data` must feature `terminationReason` attribute. -Note: The "subscription-ends" notification is not counted in the `subscriptionMaxEvents`. (for example, if a client request a `subscriptionMaxEvents` to 2, later, received second notification, then a third notification will be sent for "subscription-ends") +Following table list value for `terminationReason` attribut: + +| enum value | termination reason | +| -----------|--------------------| +| NETWORK_TERMINATED | API server stopped sending notification| +| SUBSCRIPTION_EXPIRED | Subscription expire time (optionally set by the requester) has been reached| +| MAX_EVENTS_REACHED | Maximum number of events (optionally set by the requester) has been reached| +| ACCESS_TOKEN_EXPIRED | Access Token sinkCredential (optionally set by the requester) expiration time has been reached| +| SUBSCRIPTION_DELETED | Subscription was deleted by the requester| + +Note1:This enumeration is also defined in event-subscription-template.yaml (see in [Commonalities/artifacts/camara-cloudevents](/artifacts/camara-cloudevents) directory ``event-subscription-template.yaml``). + +Note2: The "subscription-ends" notification is not counted in the `subscriptionMaxEvents`. (for example, if a client request a `subscriptionMaxEvents` to 2, later, received second notification, then a third notification will be sent for "subscription-ends") #### Error definition for event notification From 14dd8c29d4b7a7d5b98eef699bb69cf5cacaa935 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Wed, 11 Dec 2024 17:45:07 +0100 Subject: [PATCH 02/10] Update documentation/API-design-guidelines.md Co-authored-by: Rafal Artych <121048129+rartych@users.noreply.github.com> --- documentation/API-design-guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API-design-guidelines.md b/documentation/API-design-guidelines.md index 177d5d0f..f5d6bbd3 100644 --- a/documentation/API-design-guidelines.md +++ b/documentation/API-design-guidelines.md @@ -1958,7 +1958,7 @@ Specific event notification type "subscription-ends" is defined to inform listen It is used when the `subscriptionExpireTime` or `subscriptionMaxEvents` has been reached, or, if the API server has to stop sending notifications prematurely, or if the subscription request is managed asynchronously by the server and it is not able to provide the service. For this specific event, the `data` must feature `terminationReason` attribute. -Following table list value for `terminationReason` attribut: +The following table lists values for `terminationReason` attribute: | enum value | termination reason | | -----------|--------------------| From 2ba554ebedebc8beb58eb500cbd754609d38baf2 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Wed, 11 Dec 2024 17:45:15 +0100 Subject: [PATCH 03/10] Update documentation/API-design-guidelines.md Co-authored-by: Rafal Artych <121048129+rartych@users.noreply.github.com> --- documentation/API-design-guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API-design-guidelines.md b/documentation/API-design-guidelines.md index f5d6bbd3..9a15faa9 100644 --- a/documentation/API-design-guidelines.md +++ b/documentation/API-design-guidelines.md @@ -1970,7 +1970,7 @@ The following table lists values for `terminationReason` attribute: Note1:This enumeration is also defined in event-subscription-template.yaml (see in [Commonalities/artifacts/camara-cloudevents](/artifacts/camara-cloudevents) directory ``event-subscription-template.yaml``). -Note2: The "subscription-ends" notification is not counted in the `subscriptionMaxEvents`. (for example, if a client request a `subscriptionMaxEvents` to 2, later, received second notification, then a third notification will be sent for "subscription-ends") +Note2: The "subscription-ends" notification is not counted in the `subscriptionMaxEvents`. (for example, if a client request set `subscriptionMaxEvents` to 2, and later, received 2 notifications, then a third notification will be sent for "subscription-ends"). #### Error definition for event notification From 9ddb3f77e4719673a2937e13f83b20fbc9602a54 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 13 Dec 2024 11:43:11 +0100 Subject: [PATCH 04/10] Update documentation/API-design-guidelines.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Pedro Díez García --- documentation/API-design-guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API-design-guidelines.md b/documentation/API-design-guidelines.md index 9a15faa9..46b03661 100644 --- a/documentation/API-design-guidelines.md +++ b/documentation/API-design-guidelines.md @@ -1962,7 +1962,7 @@ The following table lists values for `terminationReason` attribute: | enum value | termination reason | | -----------|--------------------| -| NETWORK_TERMINATED | API server stopped sending notification| +| NETWORK_TERMINATED | API server stopped sending notification | | SUBSCRIPTION_EXPIRED | Subscription expire time (optionally set by the requester) has been reached| | MAX_EVENTS_REACHED | Maximum number of events (optionally set by the requester) has been reached| | ACCESS_TOKEN_EXPIRED | Access Token sinkCredential (optionally set by the requester) expiration time has been reached| From 10d456f68ab320e234b40450cb53d182f276eea1 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 13 Dec 2024 11:43:32 +0100 Subject: [PATCH 05/10] Update documentation/API-design-guidelines.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Pedro Díez García --- documentation/API-design-guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API-design-guidelines.md b/documentation/API-design-guidelines.md index 46b03661..e346ccca 100644 --- a/documentation/API-design-guidelines.md +++ b/documentation/API-design-guidelines.md @@ -1968,7 +1968,7 @@ The following table lists values for `terminationReason` attribute: | ACCESS_TOKEN_EXPIRED | Access Token sinkCredential (optionally set by the requester) expiration time has been reached| | SUBSCRIPTION_DELETED | Subscription was deleted by the requester| -Note1:This enumeration is also defined in event-subscription-template.yaml (see in [Commonalities/artifacts/camara-cloudevents](/artifacts/camara-cloudevents) directory ``event-subscription-template.yaml``). +Note1: This enumeration is also defined in `event-subscription-template.yaml` (placed in [Commonalities/artifacts/camara-cloudevents](/artifacts/camara-cloudevents) directory). Note2: The "subscription-ends" notification is not counted in the `subscriptionMaxEvents`. (for example, if a client request set `subscriptionMaxEvents` to 2, and later, received 2 notifications, then a third notification will be sent for "subscription-ends"). From 5eadb71095fa301bc82c01df0b3e368b47bb1ab0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pedro=20D=C3=ADez=20Garc=C3=ADa?= Date: Fri, 13 Dec 2024 11:57:59 +0100 Subject: [PATCH 06/10] Update documentation/API-design-guidelines.md --- documentation/API-design-guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API-design-guidelines.md b/documentation/API-design-guidelines.md index e346ccca..f0f3de8a 100644 --- a/documentation/API-design-guidelines.md +++ b/documentation/API-design-guidelines.md @@ -1961,7 +1961,7 @@ It is used when the `subscriptionExpireTime` or `subscriptionMaxEvents` has been The following table lists values for `terminationReason` attribute: | enum value | termination reason | -| -----------|--------------------| +| -----------|-------------------- | | NETWORK_TERMINATED | API server stopped sending notification | | SUBSCRIPTION_EXPIRED | Subscription expire time (optionally set by the requester) has been reached| | MAX_EVENTS_REACHED | Maximum number of events (optionally set by the requester) has been reached| From 58d94e1e7a7d6bb1f4c72775765575042d4cdc5c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pedro=20D=C3=ADez=20Garc=C3=ADa?= Date: Fri, 13 Dec 2024 11:58:06 +0100 Subject: [PATCH 07/10] Update documentation/API-design-guidelines.md --- documentation/API-design-guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API-design-guidelines.md b/documentation/API-design-guidelines.md index f0f3de8a..1b394998 100644 --- a/documentation/API-design-guidelines.md +++ b/documentation/API-design-guidelines.md @@ -1963,7 +1963,7 @@ The following table lists values for `terminationReason` attribute: | enum value | termination reason | | -----------|-------------------- | | NETWORK_TERMINATED | API server stopped sending notification | -| SUBSCRIPTION_EXPIRED | Subscription expire time (optionally set by the requester) has been reached| +| SUBSCRIPTION_EXPIRED | Subscription expire time (optionally set by the requester) has been reached | | MAX_EVENTS_REACHED | Maximum number of events (optionally set by the requester) has been reached| | ACCESS_TOKEN_EXPIRED | Access Token sinkCredential (optionally set by the requester) expiration time has been reached| | SUBSCRIPTION_DELETED | Subscription was deleted by the requester| From 99177528283b5e36e33dd53cbcb52ff7843a352b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pedro=20D=C3=ADez=20Garc=C3=ADa?= Date: Fri, 13 Dec 2024 11:58:13 +0100 Subject: [PATCH 08/10] Update documentation/API-design-guidelines.md --- documentation/API-design-guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API-design-guidelines.md b/documentation/API-design-guidelines.md index 1b394998..f1ca3944 100644 --- a/documentation/API-design-guidelines.md +++ b/documentation/API-design-guidelines.md @@ -1964,7 +1964,7 @@ The following table lists values for `terminationReason` attribute: | -----------|-------------------- | | NETWORK_TERMINATED | API server stopped sending notification | | SUBSCRIPTION_EXPIRED | Subscription expire time (optionally set by the requester) has been reached | -| MAX_EVENTS_REACHED | Maximum number of events (optionally set by the requester) has been reached| +| MAX_EVENTS_REACHED | Maximum number of events (optionally set by the requester) has been reached | | ACCESS_TOKEN_EXPIRED | Access Token sinkCredential (optionally set by the requester) expiration time has been reached| | SUBSCRIPTION_DELETED | Subscription was deleted by the requester| From b9a6e4738afe2742ab516ad50c832823cdd62819 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pedro=20D=C3=ADez=20Garc=C3=ADa?= Date: Fri, 13 Dec 2024 11:58:18 +0100 Subject: [PATCH 09/10] Update documentation/API-design-guidelines.md --- documentation/API-design-guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API-design-guidelines.md b/documentation/API-design-guidelines.md index f1ca3944..050b976f 100644 --- a/documentation/API-design-guidelines.md +++ b/documentation/API-design-guidelines.md @@ -1965,7 +1965,7 @@ The following table lists values for `terminationReason` attribute: | NETWORK_TERMINATED | API server stopped sending notification | | SUBSCRIPTION_EXPIRED | Subscription expire time (optionally set by the requester) has been reached | | MAX_EVENTS_REACHED | Maximum number of events (optionally set by the requester) has been reached | -| ACCESS_TOKEN_EXPIRED | Access Token sinkCredential (optionally set by the requester) expiration time has been reached| +| ACCESS_TOKEN_EXPIRED | Access Token sinkCredential (optionally set by the requester) expiration time has been reached | | SUBSCRIPTION_DELETED | Subscription was deleted by the requester| Note1: This enumeration is also defined in `event-subscription-template.yaml` (placed in [Commonalities/artifacts/camara-cloudevents](/artifacts/camara-cloudevents) directory). From ae641f518b41813de8fe6a4bbbd4ce8425db7994 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pedro=20D=C3=ADez=20Garc=C3=ADa?= Date: Fri, 13 Dec 2024 11:58:24 +0100 Subject: [PATCH 10/10] Update documentation/API-design-guidelines.md --- documentation/API-design-guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API-design-guidelines.md b/documentation/API-design-guidelines.md index 050b976f..abc7c65f 100644 --- a/documentation/API-design-guidelines.md +++ b/documentation/API-design-guidelines.md @@ -1966,7 +1966,7 @@ The following table lists values for `terminationReason` attribute: | SUBSCRIPTION_EXPIRED | Subscription expire time (optionally set by the requester) has been reached | | MAX_EVENTS_REACHED | Maximum number of events (optionally set by the requester) has been reached | | ACCESS_TOKEN_EXPIRED | Access Token sinkCredential (optionally set by the requester) expiration time has been reached | -| SUBSCRIPTION_DELETED | Subscription was deleted by the requester| +| SUBSCRIPTION_DELETED | Subscription was deleted by the requester | Note1: This enumeration is also defined in `event-subscription-template.yaml` (placed in [Commonalities/artifacts/camara-cloudevents](/artifacts/camara-cloudevents) directory).