Commit 96383082 authored by Pelayo Torres's avatar Pelayo Torres
Browse files

Event req documentation

parent 3c2b0156

doc/event-req/event-req.md

0 → 100644
+23 −0
Original line number Original line Diff line number Diff line 
# Event Reporting Information Feature



The Event Reporting Information Feature represents the requirements of the subscription, allowing users to specify the type of subscription they want, the maximum number of notifications they wish to receive, or the desired expiration date of the subscription, among other details.



## How it works



To use this feature, the supported feature **enhancedEventReport** must be enabled. With this feature activated, the **eventReq** field can be used when creating a new event subscription, containing the following information for CAPIF:



- **immRep**: Indicates an immediate report. If included and set to *true*, this specifies that periodic notifications that haven't been sent immediately for subscribed events should be sent. When a subscription is updated, all pending notifications are deleted, so it's very useful for receiving these notifications.



- **notifMethod**: Represents the notification method, which can be *PERIODIC* for subscriptions that receive notifications at regular intervals, *ONE_TIME* to receive only one notification, and *ON_EVENT_DETECTION* which sends the notification when the event occurs. If no method is specified, the default method used is *ON_EVENT_DETECTION*.



- **maxReportNbr**: Represents the maximum number of reports that can be sent before the subscription expires. It can be used with the *PERIODIC* and *ON_EVENT_DETECTION* methods, and if not specified, there is no limit.



- **monDur**: Represents the date on which the subscription expires. If no date is specified, there will be no time limit.



- **repPeriod**: Indicates the time interval in seconds between successive notification deliveries. It must be specified when the notification method is *PERIODIC*.



Using these fields provides significant benefits, such as enabling precise control over event notifications or ensuring that users receive the information when they need it. This flexibility allows for optimized resource usage, as unnecessary notifications are avoided, and the subscription can be tailored to specific use cases, improving overall efficiency and user satisfaction.



[OCF Web]: https://ocf.etsi.org/ "OCF Web"

[OCF Documentation]: https://ocf.etsi.org/documentation/ "OCF Documentation"

doc/releasenotes.md

+10 −2
Original line number Original line Diff line number Diff line
@@ -4,11 +4,18 @@ 




#### **Added Event Filters**

#### **Added Event Filters**





- Check [Event Filter section](./event-filter/event-filter.md)

- New filters for Event service subscriptions.

- New filters for Event service subscriptions.

    - You can now specify from which API, AEF, or Invoker you want to receive the event notifications.

    - You can now specify from which API, AEF, or Invoker you want to receive the event notifications.

    - These filters are specified in the ***eventFilters*** of the subscription if the ***Enhanced Event Report*** feature of the ***Supported Features*** is activated.

    - These filters are specified in the ***eventFilters*** 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].

- More detailed information about event filters can be found in [Event Filter section](./event-filter/event-filter.md).



#### **Added Event Reporting Information**



- New Reporting Information for event subscriptions.

    - Now, you can specify the type of subscription you want: periodic, when an event is detected or one-time.

    - Fields have been added to allow setting a maximum number of notifications and the subscription expiration time.

    - You can now immediately get periodic notifications that have not been sent.

- More detailed information about the Reporting Information can be found in [Event Reporting Information section](./event-req/event-req.md)





### **Testing**

### **Testing**
@@ -55,6 +62,7 @@ This will also helps on the restart issue on k8s deployed OpenCAPIF. 
- New [Vendor Extensibility section](./vendor-ext/vendor-ext.md)

- New [Vendor Extensibility section](./vendor-ext/vendor-ext.md)

- New [API Status section](./api-status/api-status.md)

- New [API Status section](./api-status/api-status.md)

- New [Dynamic Configuration section](./configuration/configuration.md)

- New [Dynamic Configuration section](./configuration/configuration.md)

- New [Event Reporting Information section](./event-req/event-req.md)





#### Testplan

#### Testplan

- New tests related with [Api Status Feature](./testing/testplan/api_status/README.md).

- New tests related with [Api Status Feature](./testing/testplan/api_status/README.md).

mkdocs.yml

+1 −0
Original line number Original line Diff line number Diff line
@@ -94,6 +94,7 @@ nav: 
      - Api Status: ./api-status/api-status.md

      - Api Status: ./api-status/api-status.md

      - Event Filter: ./event-filter/event-filter.md

      - Event Filter: ./event-filter/event-filter.md

      - Dynamic Configuration: ./configuration/configuration.md

      - Dynamic Configuration: ./configuration/configuration.md

      - Event Reporting Information: ./event-req/event-req.md

  - SDK:

  - SDK:

      - Introduction: ./sdk/sdk.md

      - Introduction: ./sdk/sdk.md

  - Example Clients:

  - Example Clients: