From b20db7585ec0da7b58e00eaee9213fa27fd5e01d Mon Sep 17 00:00:00 2001 From: Maximilian Laue Date: Fri, 21 Jun 2024 13:10:55 +0200 Subject: [PATCH 1/3] feat: add termination reason when subscription deleted --- .../device-reachability-status-subscriptions.yaml | 8 +++++++- .../device-roaming-status-subscriptions.yaml | 2 ++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/code/API_definitions/device-reachability-status-subscriptions.yaml b/code/API_definitions/device-reachability-status-subscriptions.yaml index f8140c30..6cc5ec79 100644 --- a/code/API_definitions/device-reachability-status-subscriptions.yaml +++ b/code/API_definitions/device-reachability-status-subscriptions.yaml @@ -36,7 +36,11 @@ info: Note: Additionally to these list, ``org.camaraproject.reachability-status-subscriptions.v0.subscription-ends`` notification `type` is sent when the subscription ends. This notification does not require dedicated subscription. - It is used when the subscription expire time (optionally set by the requester) has been reached or if the API server has to stop sending notification prematurely. + + It is used when: + - the subscription expire time (optionally by the requester) has been reached + - the subscription was deleted by the requester + - the API server has to stop sending notification prematurely. ### Notifications callback @@ -646,9 +650,11 @@ components: description: | NETWORK_TERMINATED - API server stopped sending notification SUBSCRIPTION_EXPIRED - Subscription expire time (optionally set by the requester) has been reached + SUBSCRIPTION_DELETED - Subscription was deleted by the requester enum: - NETWORK_TERMINATED - SUBSCRIPTION_EXPIRED + - SUBSCRIPTION_DELETED responses: Generic400: diff --git a/code/API_definitions/device-roaming-status-subscriptions.yaml b/code/API_definitions/device-roaming-status-subscriptions.yaml index 50207f92..f910f031 100644 --- a/code/API_definitions/device-roaming-status-subscriptions.yaml +++ b/code/API_definitions/device-roaming-status-subscriptions.yaml @@ -717,9 +717,11 @@ components: description: | NETWORK_TERMINATED - API server stopped sending notification SUBSCRIPTION_EXPIRED - Subscription expire time (optionally set by the requester) has been reached + SUBSCRIPTION_DELETED - Subscription was deleted by the requester enum: - NETWORK_TERMINATED - SUBSCRIPTION_EXPIRED + - SUBSCRIPTION_DELETED responses: Generic400: From 0c7c8e2b6915ff617a4bce6f9b0ccc576e6aba0c Mon Sep 17 00:00:00 2001 From: Maximilian Laue Date: Fri, 21 Jun 2024 13:12:02 +0200 Subject: [PATCH 2/3] fix: add documentation about subscription-ends in device-roaming-status-subscriptions.yaml --- .../device-roaming-status-subscriptions.yaml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/code/API_definitions/device-roaming-status-subscriptions.yaml b/code/API_definitions/device-roaming-status-subscriptions.yaml index f910f031..0f41158c 100644 --- a/code/API_definitions/device-roaming-status-subscriptions.yaml +++ b/code/API_definitions/device-roaming-status-subscriptions.yaml @@ -38,7 +38,11 @@ info: Note: Additionally to these list, ``org.camaraproject.roaming-status-subscriptions.v0.subscription-ends`` notification `type` is sent when the subscription ends. This notification does not require dedicated subscription. - It is used when the subscription expire time (optionally set by the requester) has been reached or if the API server has to stop sending notification prematurely. + + It is used when: + - the subscription expire time (optionally by the requester) has been reached + - the subscription was deleted by the requester + - the API server has to stop sending notification prematurely. ### Notifications callback From df9fa6b493fdbc4ae4a0373721f5cd32a831c6aa Mon Sep 17 00:00:00 2001 From: Maximilian Laue Date: Fri, 21 Jun 2024 14:01:02 +0200 Subject: [PATCH 3/3] fix: updating description --- .../device-reachability-status-subscriptions.yaml | 2 +- code/API_definitions/device-roaming-status-subscriptions.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/code/API_definitions/device-reachability-status-subscriptions.yaml b/code/API_definitions/device-reachability-status-subscriptions.yaml index 6cc5ec79..df9c728c 100644 --- a/code/API_definitions/device-reachability-status-subscriptions.yaml +++ b/code/API_definitions/device-reachability-status-subscriptions.yaml @@ -37,7 +37,7 @@ info: Note: Additionally to these list, ``org.camaraproject.reachability-status-subscriptions.v0.subscription-ends`` notification `type` is sent when the subscription ends. This notification does not require dedicated subscription. - It is used when: + It is used in following cases: - the subscription expire time (optionally by the requester) has been reached - the subscription was deleted by the requester - the API server has to stop sending notification prematurely. diff --git a/code/API_definitions/device-roaming-status-subscriptions.yaml b/code/API_definitions/device-roaming-status-subscriptions.yaml index 0f41158c..9b15bdca 100644 --- a/code/API_definitions/device-roaming-status-subscriptions.yaml +++ b/code/API_definitions/device-roaming-status-subscriptions.yaml @@ -39,7 +39,7 @@ info: Note: Additionally to these list, ``org.camaraproject.roaming-status-subscriptions.v0.subscription-ends`` notification `type` is sent when the subscription ends. This notification does not require dedicated subscription. - It is used when: + It is used in following cases: - the subscription expire time (optionally by the requester) has been reached - the subscription was deleted by the requester - the API server has to stop sending notification prematurely.