diff --git a/README.md b/README.md
index 06af09a9b813490b0284182b348fa103db3f6cdc..4836fb0042383b57886e3925ddbcd842fb0337ee 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,8 @@
# OpenCAPIF SDK
+
+
This repository develop a Python Software Development Kit(SDK) whis focuses on connecting to OpenCAPIF in a simple way, lowering integration complexity and allowing developers to focus on Network Functions (NF) or services development.
OpentCAPIF SDK provides a set of libraries to enable either CAPIF provider and invoker roles, and other functions to simplify procedures calls towards OpenCAPIF.
@@ -9,30 +11,37 @@ OpentCAPIF SDK provides a set of libraries to enable either CAPIF provider and i
Current version of OpenCAPIF SDK is compatible with following publicly available releases:
- OpenCAPIF Release 1.0 [LINK TO OPENCAPIF RELEASE]
-# Features
+# Table of Contents
+
+ 1. [OpenCAPIF SDK usage](#OpenCAPIF-SDK-usage)
+ 2. [OpenCAPIF SDK Features](#OpenCAPIF-SDK-Features)
+ 3. [OpenCAPIF SDK Installation](#OpenCAPIF-SDK-Installation)
+ 4. [How to use OpenCAPIF SDK](#How-to-use-OpenCAPIF-SDK)
+ 5. [OpenCAPIF SDK known issues](#OpenCAPIF-SDK-known-issues)
+
+# OpenCAPIF SDK usage
+
+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.
-OpenCAPIF SDK implements this set of features to integrate with CAPIF NF:
+This repository includes 2 different modes to test OpenCAPIF SDK:
+- **Manual usage**: use a set of python scripts to test step by step all implemented procedures. All of them are provided at scripts folder,
+[IMAGE OF ARCH APP ----> CAPIF WITH SCRIPTS]
+
+- **Development usage**: import SDK in your code and start ... Within nf-sample folder, it is provided a sample application leveraging
+[IMAGE OF ARCH APP ----> CAPIF WITH SDK INTEGRATION]
+
+# OpenCAPIF SDK Features
- **Invoker CAPIF connector**: Simplifies the process of onboarding for Invoker users,
-
- **Provider CAPIF connector**: Simplifies the process of onboarding for Provider users,also has the capability to register several APF's and AEF's if its necesary,
-
- **Invoker Service Discovery**: Facilitates making a Discovery request to CAPIF, also stores the API services recieved and has an option to filter them,
-
- **Invoker Service Get token**: After the Discovery, this functionality simplifies the way of getting created their propperly security context for each of the services and adquiring the access token to use the final APIs,
-
- **Provider Publish API**: Simplifies the process of publishing an API. Also has the capability to chose which APF and AEF's will be used to publish the API,
-
- **Provider Unpublish API**: Simplifies the process of deleting an API,
-
- **Provider Update API**: Simplifies the process of updating an API. Also has the capability to chose which APF and AEF's will be used to update the API,
-
- **Provider Get API**: Simplifies the process of recieving the information of One service published previously,
-
- **Provider Get all APIs**: Simplifies the process of recieving the information of all available services published previously,
-
- **Invoker CAPIF connector offboarding**: Simplifies the process of offboarding for Invoker users,
-
- **Provider CAPIF connector offboarding**: Simplifies the process of offboarding for Provider users.
@@ -48,8 +57,7 @@ Apart from the SDK core, there are available different functionalities for devel
-
-# OpenCAPIF SDK Installation
+# OpenCAPIF SDK Installation (dev environment??)
Follow next steps to perform OpenCAPIF SDK installation:
@@ -103,7 +111,11 @@ pip install -r requirements.txt
2 - Then it is needed to fill out config files depending on the features required to be used from the SDK.
-## Configuration of Config.json
+## Prerequisites
+
+IMPORTANT: In order to leverage OpenCAPIF SDK it is required to have registered a user in the target CAPIF instance, so contact administrator to have required predefined credentials (username and password).
+
+## Configuration via Config.json
"invoker_folder": String | The path (relative or absolute) of the folder you want to store your invoker information
@@ -252,3 +264,6 @@ Each field is obligatory to complete except UUID, which is only obligatory in ca
Although this field is not obligatory we recomend to store the UUID parameter recieved by the Register and login functionality in this field.
+# OpenCAPIF SDK known issues
+
+[TO PUT HERE ALL KNOWN ISSUES OR BACKLOG]
\ No newline at end of file
diff --git a/Functionalities/capif_exposer_sample_files/provider_api_description_sample.json b/api-samples/provider_api_description_sample.json
similarity index 100%
rename from Functionalities/capif_exposer_sample_files/provider_api_description_sample.json
rename to api-samples/provider_api_description_sample.json
diff --git a/Functionalities/Config_files/config.json b/config/config.json
similarity index 100%
rename from Functionalities/Config_files/config.json
rename to config/config.json
diff --git a/Functionalities/Config_files/discover_filter.json b/config/discover_filter.json
similarity index 100%
rename from Functionalities/Config_files/discover_filter.json
rename to config/discover_filter.json
diff --git a/Functionalities/Config_files/publish.json b/config/publish.json
similarity index 100%
rename from Functionalities/Config_files/publish.json
rename to config/publish.json
diff --git a/Functionalities/Config_files/register.json b/config/register.json
similarity index 100%
rename from Functionalities/Config_files/register.json
rename to config/register.json
diff --git a/images/OpenCAPIF-icon.jpg b/images/OpenCAPIF-icon.jpg
new file mode 100644
index 0000000000000000000000000000000000000000..8ae5c10e186e12481f1e65f36b69ac722f057775
Binary files /dev/null and b/images/OpenCAPIF-icon.jpg differ
diff --git a/nf-samples/README.md b/nf-samples/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..d5319178a705d5a4e8bd0dc1b16564bd0958ffac
--- /dev/null
+++ b/nf-samples/README.md
@@ -0,0 +1 @@
+AQUà EL CÓDIGO DE EJMEMPLO DE UNA NF/APP QUE HACE USO DEL SDK
\ No newline at end of file
diff --git a/scripts/README.md b/scripts/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..3f10aabc3b660865bc3091f37f0584708878326d
--- /dev/null
+++ b/scripts/README.md
@@ -0,0 +1 @@
+AQUÃ TODOS LOS SCRIPTS DEL SDK
\ No newline at end of file
diff --git a/Functionalities/deregister_and_login.py b/scripts/deregister_and_login.py
similarity index 100%
rename from Functionalities/deregister_and_login.py
rename to scripts/deregister_and_login.py
diff --git a/Functionalities/emulator_utils.py b/scripts/emulator_utils.py
similarity index 100%
rename from Functionalities/emulator_utils.py
rename to scripts/emulator_utils.py
diff --git a/Functionalities/invoker_capif_connector.py b/scripts/invoker_capif_connector.py
similarity index 100%
rename from Functionalities/invoker_capif_connector.py
rename to scripts/invoker_capif_connector.py
diff --git a/Functionalities/invoker_capif_connector_offboarding.py b/scripts/invoker_capif_connector_offboarding.py
similarity index 100%
rename from Functionalities/invoker_capif_connector_offboarding.py
rename to scripts/invoker_capif_connector_offboarding.py
diff --git a/Functionalities/invoker_service_discovery.py b/scripts/invoker_service_discovery.py
similarity index 100%
rename from Functionalities/invoker_service_discovery.py
rename to scripts/invoker_service_discovery.py
diff --git a/Functionalities/invoker_service_get_token.py b/scripts/invoker_service_get_token.py
similarity index 100%
rename from Functionalities/invoker_service_get_token.py
rename to scripts/invoker_service_get_token.py
diff --git a/Functionalities/provider_capif_connector.py b/scripts/provider_capif_connector.py
similarity index 100%
rename from Functionalities/provider_capif_connector.py
rename to scripts/provider_capif_connector.py
diff --git a/Functionalities/provider_capif_connector_offboarding.py b/scripts/provider_capif_connector_offboarding.py
similarity index 100%
rename from Functionalities/provider_capif_connector_offboarding.py
rename to scripts/provider_capif_connector_offboarding.py
diff --git a/Functionalities/provider_get_all_published_api.py b/scripts/provider_get_all_published_api.py
similarity index 100%
rename from Functionalities/provider_get_all_published_api.py
rename to scripts/provider_get_all_published_api.py
diff --git a/Functionalities/provider_get_published_api.py b/scripts/provider_get_published_api.py
similarity index 100%
rename from Functionalities/provider_get_published_api.py
rename to scripts/provider_get_published_api.py
diff --git a/Functionalities/provider_publish_api.py b/scripts/provider_publish_api.py
similarity index 100%
rename from Functionalities/provider_publish_api.py
rename to scripts/provider_publish_api.py
diff --git a/Functionalities/provider_unpublish_api.py b/scripts/provider_unpublish_api.py
similarity index 100%
rename from Functionalities/provider_unpublish_api.py
rename to scripts/provider_unpublish_api.py
diff --git a/Functionalities/provider_update_api.py b/scripts/provider_update_api.py
similarity index 100%
rename from Functionalities/provider_update_api.py
rename to scripts/provider_update_api.py
diff --git a/Functionalities/register_and_login.py b/scripts/register_and_login.py
similarity index 100%
rename from Functionalities/register_and_login.py
rename to scripts/register_and_login.py
diff --git a/Safe-6g/sdk.py b/sdk/sdk.py
similarity index 100%
rename from Safe-6g/sdk.py
rename to sdk/sdk.py