Commit 897fc227 authored by Daniel García's avatar Daniel García
Browse files

Update doc

parent 4a7c4eb2
Loading
Loading
Loading
Loading
+16 −16
Original line number Diff line number Diff line
@@ -25,22 +25,22 @@ Current version of OpenCAPIF SDK is compatible with following publicly available

OpenCAPIF SDK brings a set of functions to integrate with the 5G Core's function CAPIF, as defined in [3GPP Technical Specification (TS) 29.222 V18.5.0 Common API Framework for 3GPP Northbound APIs](https://www.etsi.org/deliver/etsi_ts/129200_129299/129222/18.05.00_60/ts_129222v180500p.pdf). This section shows the mapping between the Python functions available in this SDK and the CAPIF OpenAPI APIs defined the reference standard:

| **CAPIF API**                                   | **OpenCAPIF SDK function**                                  |
|-------------------------------------------------|-------------------------------------------------------------|
| onboardedInvokers (POST)                        | onboard_invoker()                                           |
| onboardedInvokers (PUT)                         | update_invoker()                                            |
| onboardedInvokers (DELETE)                      | offboard_invoker()                                          |
| registrations (POST)                            | onboard_provider()                                          |
| registrations (PUT)                             | update_provider()                                           |
| registrations (DELETE)                          | offboard_provider()                                         |
| allServiceAPIs (GET)                            | discover()                                                  |
| trustedInvokers (PUT//POST)                     | discover()                                                  |
| securities/{securityId}/token                   | get_tokens()                                                 |
| service-apis (POST)                             | publish_services()                                          |
| service-apis (DELETE)                           | unpublish_service()                                         |
| service-apis (PUT)                              | update_service()                                            |
| service-apis (GET)                              | get_service()                                               |
| service-apis (GET)                              | get_all_services()                                          |
| **CAPIF API**                                   | **OpenCAPIF SDK function**                                  | **Description**                                             |
|-------------------------------------------------|-------------------------------------------------------------|-------------------------------------------------------------|
| onboardedInvokers (POST)                        | onboard_invoker()                                           | Registers a new invoker.                                    |
| onboardedInvokers (PUT)                         | update_invoker()                                            | Updates an existing invoker.                                |
| onboardedInvokers (DELETE)                      | offboard_invoker()                                          | Deletes an invoker.                                         |
| registrations (POST)                            | onboard_provider()                                          | Registers a new service provider.                           |
| registrations (PUT)                             | update_provider()                                           | Updates a service provider's registration.                  |
| registrations (DELETE)                          | offboard_provider()                                         | Deletes a service provider's registration.                  |
| allServiceAPIs (GET)                            | discover()                                                  | Retrieves a list of all available service APIs.             |
| trustedInvokers (PUT//POST)                     | discover()                                                  | Registers or updates trusted invokers.                      |
| securities/{securityId}/token (GET)             | get_tokens()                                                | Retrieves a security token for a specific `securityId`.     |
| service-apis (POST)                             | publish_services()                                          | Registers a new service API into the system.                |
| service-apis (DELETE)                           | unpublish_service()                                         | Deletes a service API from the system.                      |
| service-apis (PUT)                              | update_service()                                            | Updates the details of an existing service API.             |
| service-apis (GET)                              | get_service()                                               | Retrieves the details of a specific service API.            |
| service-apis (GET)                              | get_all_services()                                          | Retrieves a list of all available service APIs.             |


NOTE: Above mentioned CAPIF APIs are defined in these 3GPP references:
+1 −1
Original line number Diff line number Diff line
@@ -2,7 +2,7 @@

OpenCAPIF SDK implements this set of features to easily integrate an application with CAPIF NF either manually or integrating SDK library directly within app code.

Before usage it's needed to have completed the [prerequirements](./sdk-prerequirements.md) section, the [installation](./sdk-installation.md) section and the selected parts of the [configuration](./sdk-configuration.md) section.
Before using it, it is required to have fullfiled the [prerequirements](./sdk-prerequirements.md) section, the [installation](./sdk-installation.md) section and the selected parts of the [configuration](./sdk-configuration.md) depending on the CAPIF role the NetApp is going to play.


![GENERAL CAPIF USAGE FLOW](./images/Flujo%20completo-OPENCAPIF%20ACTUAL.jpg)