diff --git a/doc/sdk-configuration.md b/doc/sdk-configuration.md index 4b9fd47d4a755163d91ec7cb3230849cdbc2e671..d8c792faa991a8a085f89859e5ee19879d3149cc 100644 --- a/doc/sdk-configuration.md +++ b/doc/sdk-configuration.md @@ -1,9 +1,15 @@ -## OpenCAPIF SDK configuration +# OpenCAPIF SDK configuration 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 -### **1. Configuration via Config.json** + +- [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 via Register.json](#configuration-via-registerjson) + +## **1. Configuration via Config.json** This file could also be fullfilled by [enviroment variables](../samples/enviroment-variables-sample.txt) @@ -56,7 +62,7 @@ If you want to use SDK as a **Provider** you need to fill out these fields - APFs - AEFs -### **2. Configuration of Publish.json** +## **2. Configuration via Publish.json** 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) @@ -72,7 +78,7 @@ For using the Publish Api function or the Update function the provider_api_descr -#### **Configuration of Discover_filter.json** +## **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. @@ -80,12 +86,14 @@ To use this feature it has to be completed `Discover_filter.json` with the param To run the Invoker Service Discovery Functionality it has to be onboarded as an Invoker before the CAPIF user. -#### **Configuration of Register.json** +## **Configuration via Register.json** In order to use this SDK in a Local enviroment and creating and removing users, its mandatory to fullfill this fields. This Feature is not included in the SDK. +[Here](https://labs.etsi.org/rep/ocf/capif/-/tree/REL1?ref_type=heads) is the link to the CAPIF oficial repository if it's wanted to create the Local enviroment + - register_host:The domain name of your register host - capif_register_port: The port of your register host - capif_register_username: CAPIF admin username