TELCODOCS#1912: Added API endpoints for delete subscription and delete all subscriptions

Author: sr1kar99

modules/cnf-fast-event-notifications-api-refererence.adoc

@@ -63,26 +63,44 @@ Creates a new subscription. If a subscription is successfully created, or if it
 }
 ----
 
+[discrete]
+=== HTTP method
+
+`DELETE api/ocloudNotifications/v1/subscriptions`
+
+[discrete]
+=== Description
+
+Deletes all subscriptions.
+
+.Example API response
+[source,json]
+----
+{
+"status": "deleted all subscriptions"
+}
+----
+
 [id="api-ocloud-notifications-v1-subscriptions-subscription_id_{context}"]
-== api/ocloudNotifications/v1/subscriptions/<subscription_id>
+== api/ocloudNotifications/v1/subscriptions/{subscription_id}
 
 [discrete]
 === HTTP method
 
-`GET api/ocloudNotifications/v1/subscriptions/<subscription_id>`
+`GET api/ocloudNotifications/v1/subscriptions/{subscription_id}`
 
 [discrete]
 === Description
 
-Returns details for the subscription with ID `<subscription_id>`
+Returns details for the subscription with ID `subscription_id`.
 
-.Query parameters
+.Global path parameters
 [cols=2*, width="60%", options="header"]
 |====
 |Parameter
 |Type
 
-|`<subscription_id>`
+|`subscription_id`
 |string
 |====
 
@@ -97,6 +115,34 @@ Returns details for the subscription with ID `<subscription_id>`
 }
 ----
 
+[discrete]
+=== HTTP method
+
+`DELETE api/ocloudNotifications/v1/subscriptions/{subscription_id}`
+
+[discrete]
+=== Description
+
+Deletes the subscription with ID `subscription_id`.
+
+.Global path parameters
+[cols=2*, width="60%", options="header"]
+|====
+|Parameter
+|Type
+
+|`subscription_id`
+|string
+|====
+
+.Example API response
+[source,json]
+----
+{
+"status": "OK"
+}
+----
+
 [id="api-ocloudnotifications-v1-health_{context}"]
 == api/ocloudNotifications/v1/health
 
@@ -286,7 +332,7 @@ $ oc logs -f linuxptp-daemon-cvgr6 -n openshift-ptp -c cloud-event-proxy
 ----
 
 [id="resource-address-current-state_{context}"]
-== api/ocloudNotifications/v1/<resource_address>/CurrentState
+== api/ocloudNotifications/v1/{resource_address}/CurrentState
 
 [discrete]
 === HTTP method
@@ -306,13 +352,13 @@ Configure the `CurrentState` API endpoint to return the current state of the `os
 * `ptp-clock-class-change` notifications describe the current state of the PTP clock class.
 * `lock-state` notifications describe the current status of the PTP equipment lock state. Can be in `LOCKED`, `HOLDOVER` or `FREERUN` state.
 
-.Query parameters
+.Global path parameters
 [cols=2*, width="60%", options="header"]
 |====
 |Parameter
 |Type
 
-|`<resource_address>`
+|`resource_address`
 |string
 |====
 

networking/ptp/using-ptp-events.adoc

@@ -36,17 +36,19 @@ Use the following API endpoints to subscribe the `cloud-event-consumer` DU appli
 * xref:../../networking/ptp/using-ptp-events.adoc#api-ocloud-notifications-v1-subscriptions_{context}[`/api/ocloudNotifications/v1/subscriptions`]
 - `POST`: Creates a new subscription
 - `GET`: Retrieves a list of subscriptions
+- `DELETE`: Deletes all subscriptions
 
-* xref:../../networking/ptp/using-ptp-events.adoc#api-ocloud-notifications-v1-subscriptions-subscription_id_{context}[`/api/ocloudNotifications/v1/subscriptions/<subscription_id>`]
+* xref:../../networking/ptp/using-ptp-events.adoc#api-ocloud-notifications-v1-subscriptions-subscription_id_{context}[`/api/ocloudNotifications/v1/subscriptions/{subscription_id}`]
 - `GET`: Returns details for the specified subscription ID
+- `DELETE`: Deletes the subscription associated with the specified subscription ID
 
 * xref:../../networking/ptp/using-ptp-events.adoc#api-ocloudnotifications-v1-health_{context}[`/api/ocloudNotifications/v1/health`]
 - `GET`: Returns the health status of `ocloudNotifications` API
 
 * xref:../../networking/ptp/using-ptp-events.adoc#api-ocloudnotifications-v1-publishers_{context}[`api/ocloudNotifications/v1/publishers`]
 - `GET`: Returns an array of `os-clock-sync-state`, `ptp-clock-class-change`, `lock-state`, and `gnss-sync-status` messages for the cluster node
 
-* xref:../../networking/ptp/using-ptp-events.adoc#resource-address-current-state_{context}[`/api/ocloudnotifications/v1/<resource_address>/CurrentState`]
+* xref:../../networking/ptp/using-ptp-events.adoc#resource-address-current-state_{context}[`/api/ocloudnotifications/v1/{resource_address}/CurrentState`]
 - `GET`: Returns the current state of one the following event types: `os-clock-sync-state`, `ptp-clock-class-change`, `lock-state`, or `gnss-state-change` events
 
 [NOTE]