Commit a008a7ce authored by JorgeEcheva26's avatar JorgeEcheva26
Browse files

READme configuration updated

parent aa353f55
Loading
Loading
Loading
Loading
+4 −4
Original line number Diff line number Diff line
@@ -34,12 +34,12 @@ OpenCAPIF SDK brings a set of functions to integrate with the 5G Core's function
| registrations (PUT)                             | update_provider()                                           |
| registrations (DELETE)                          | offboard_provider()                                         |
| allServiceAPIs (GET)                            | discover()                                                  |
| service-apis (POST)                             | publish_services(service_api_description_json_full_path)    |
| service-apis (DELETE)                           | unpublish_service(service_api_description_json_full_path)   |
| service-apis (PUT)                              | update_service(service_api_description_json_full_path)      |
| 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()                                          |
| trustedInvokers (PUT)                           | discover()                                                  |
| trustedInvokers (PUT//POST)                     | discover()                                                  |

NOTE: Above mentioned CAPIF APIs are defined in these 3GPP references:
- [CAPIF Invoker API specification](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_CAPIF_API_Invoker_Management_API.yaml)
+23 −13
Original line number Diff line number Diff line
@@ -2,11 +2,11 @@

Before configuration it's needed to have completed the [prerequirements](./sdk-prerequirements.md) section and the [installation](./sdk-installation.md) section.

IMPORTANT: All jsons configuration files **MUST** be in the same folder


- [Configuration via Config.json](#1-configuration-via-configjson)
- [Configuration via Publish.json](#2-configuration-via-publishjson)
- [Configuration via Discover_filter.json](#3configuration-via-discover_filterjson)
- [Configuration of Discover_filter](#configuration-of-discover_filter)
- [Configuration of Publish](#configuration-of-publish_req)
- [Configuration via Register.json](#configuration-via-registerjson)

## **1. Configuration via Config.json**
@@ -50,21 +50,37 @@ Mandatory fields no matter the target role to be onboarded, either invoker or pr
- capif_password
- debug_mode

If you want to use SDK as an **Invoker** you need to fill out these fields
If you want to use SDK as an **Invoker** is mandatory to fill out these fields

- invoker_folder
- capif_callback_url
- csr_information(csr_common_name,csr_country_name...)

If you want to use SDK as a **Provider** you need to fill out these fields
OPTIONAL:
- [discover_filter](#2configuration-via-discover_filterjson)

If you want to use SDK as a **Provider** is mandatory to fill out these fields

- provider_folder
- APFs
- AEFs
     
## **2. Configuration via Publish.json**
Mandatory to use [CAPIF Publish API specification](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_CAPIF_Publish_Service_API.yaml) :

- [publish_req](#3-configuration-via-publishjson)


This configuration file is only mandatory if we want to use the [CAPIF_Publish_Service_API](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_CAPIF_Publish_Service_API.yaml) 
## **Configuration of discover_filter**
This file follows the parameters schema from the GET petition of  [Discover Services API](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_CAPIF_Discover_Service_API.yaml) 

To use this feature it has to be completed `discover_filter` with the parameters you want to be filtered in order to run the Invoker Service Discovery Functionality.

To run the Invoker Service Discovery Functionality it has to be onboarded as an Invoker before the CAPIF user.


## **Configuration of publish_req**

This configuration fields is only mandatory if we want to use the [CAPIF_Publish_Service_API](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_CAPIF_Publish_Service_API.yaml) 

   - serviceApiId: The Api id we want to use Example "02eff6e1b3a8f7c8044a92ee8a30bd"
   - publisherAPFid: APF id we chose to use Example : "APFa165364a379035d14311deadc04332"
@@ -78,12 +94,6 @@ For using the Publish Api function or the Update function the provider_api_descr



## **3.Configuration via Discover_filter.json**
This file follows the parameters schema from the GET petition of  [Discover Services API](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_CAPIF_Discover_Service_API.yaml) 

To use this feature it has to be completed `Discover_filter.json` with the parameters you want to be filtered in order to run the Invoker Service Discovery Functionality.

To run the Invoker Service Discovery Functionality it has to be onboarded as an Invoker before the CAPIF user.


## **Configuration via Register.json**
+0 −1
Original line number Diff line number Diff line
@@ -4,7 +4,6 @@ OpenCAPIF SDK implements this set of features to easily integrate an application

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.

IMPORTANT: All jsons configuration files **MUST** be in the same folder

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