From b62264143dacfadaa6ffcff16ac1aefb7e49142e Mon Sep 17 00:00:00 2001
From: Pelayo Torres <pelayo.torresalonso@telefonica.com>
Date: Mon, 24 Feb 2025 12:22:13 +0100
Subject: [PATCH] event filter page
---
doc/event-filter/event-filter.md | 36 ++++++++++++++++++++++++++++++++
doc/releasenotes.md | 7 +++++--
mkdocs.yml | 1 +
3 files changed, 42 insertions(+), 2 deletions(-)
create mode 100644 doc/event-filter/event-filter.md
diff --git a/doc/event-filter/event-filter.md b/doc/event-filter/event-filter.md
new file mode 100644
index 0000000..38755d9
--- /dev/null
+++ b/doc/event-filter/event-filter.md
@@ -0,0 +1,36 @@
+# Event Filter
+
+The **Event Filter** is a feature of the CAPIF Events service that allows you to receive specific notifications about the events you are subscribed to. This tool is essential for efficiently managing and monitoring relevant events, ensuring that users receive only the information they need.
+
+## How it works
+
+To specify the desired filter during subscription, you can use the ***eventDetails*** field, provided that the ***Enhanced Event Report*** flag is enabled in the ***Supported Features*** characteristics.
+
+The ***eventDetails*** field consists of a list of filters that correspond one-to-one with the list of events in the ***events*** field. Thus, the first element of the filter list corresponds to the first element of the events list, the second filter element to the second event element, and so on.
+
+Each filter contains three lists:
+
+- **apiIds**: Identifiers of the APIs from which you want to receive notifications.
+- **apiInvokerIds**: Identifiers of the invokers from which you want to receive notifications.
+- **aefIds**: Identifiers of the AEFs from which you want to receive notifications.
+
+Depending on the event you subscribe to, you can use one or more of these lists. The following table shows the filtering options available for each event:
+
+| Event | apiIds | aefIds | apiInvokerIds |
+|---------------------------------|:------:|:------:|:-------------:|
+| SERVICE_API_AVAILABLE | X | | |
+| SERVICE_API_UNAVAILABLE | X | | |
+| SERVICE_API_UPDATE | X | | |
+| API_INVOKER_ONBOARDED | | | X |
+| API_INVOKER_OFFBOARDED | | | X |
+| API_INVOKER_UPDATED | | | X |
+| ACCESS_CONTROL_POLICY_UPDATE | X | | X |
+| SERVICE_API_INVOCATION_SUCCESS | X | X | X |
+| SERVICE_API_INVOCATION_FAILURE | X | X | X |
+| API_TOPOLOGY_HIDING_CREATED | | | |
+| API_TOPOLOGY_HIDING_REVOKED | | | |
+
+In cases where 2 or 3 lists are specified simultaneously for an event, notifications will only be sent when there is at least one matching element in each of the subscription lists. For example, if you subscribe to the ***ACCESS_CONTROL_POLICY_UPDATE*** event using the ***apiIds*** and ***apiInvokerIds*** filter lists, you will only be notified when the access control policy update corresponds to an API in the ***apiIds*** list and an invoker in the ***apiInvokerIds*** list at the same time.
+
+[OCF Web]: https://ocf.etsi.org/ "OCF Web"
+[OCF Documentation]: https://ocf.etsi.org/documentation/ "OCF Documentation"
diff --git a/doc/releasenotes.md b/doc/releasenotes.md
index 4f1748c..6eeb8e5 100644
--- a/doc/releasenotes.md
+++ b/doc/releasenotes.md
@@ -3,9 +3,11 @@
### **New Features**
#### **Added Event Filters**
+
- New filters for Event service subscriptions.
- - Now, you can specify from which API, AEF or Invoker you want to receive the event.
- - These filters are specified in the ***eventDetails*** of the subscription.
+ - You can now specify from which API, AEF, or Invoker you want to receive the event notifications.
+ - These filters are specified in the ***eventDetails*** of the subscription if the ***Enhanced Event Report*** feature of the ***Supported Features*** is activated.
+- More detailed information about event filters can be found in [Event Filter].
## **Release 2.0.0**
@@ -346,3 +348,4 @@ This Release also includes a Robot Test Suite for all those services and a Postm
[New Registration Demo]: https://www.youtube.com/watch?v=sn-tN6eRvv8 "New Registration Demo"
[CICD Wiki]: https://labs.etsi.org/rep/ocf/community/-/wikis/OCF-CICD "CI/CD Wiki"
[Upgrade Release 17 to 18 Wiki]: https://labs.etsi.org/rep/ocf/community/-/wikis/3GPP-Release-18-upgrade "Upgrade Release 17 to 18 Wiki"
+[Event Filter]: https://labs.etsi.org/rep/ocf/documentation/latest/event-filter/event-filter/ "Event Filter"
diff --git a/mkdocs.yml b/mkdocs.yml
index 902fb2d..3135544 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -81,6 +81,7 @@ nav:
- Features:
- Vendor Extensibility: ./vendor-ext/vendor-ext.md
- Api Status: ./api-status/api-status.md
+ - Event Filter: ./event-filter/event-filter.md
- SDK:
- Introduction: ./sdk/sdk.md
- Example Clients:
--
GitLab