From 67ca1d80496d0d5adecb97a0b62ff032c3e9ce85 Mon Sep 17 00:00:00 2001 From: JorgeEcheva26 <jorge.echevarriauribarri.practicas@telefonica.es> Date: Fri, 20 Sep 2024 09:29:05 +0200 Subject: [PATCH] Change features --- README.md | 49 +++++++++++++++++++++------------------- doc/sdk-prerequesites.md | 7 +++++- 2 files changed, 32 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 965dcea..7d93739 100644 --- a/README.md +++ b/README.md @@ -14,46 +14,49 @@ Current version of OpenCAPIF SDK is compatible with following publicly available # OpenCAPIF SDK Features -- CAPIF_API_Invoker_management API +- [CAPIF_API_Invoker_management API](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_CAPIF_API_Invoker_Management_API.yaml) - - Onboard_API_Invoker + - Onboard_API_Invoker: Corresponds to register_and_onboard_Invoker() - - Update_API_Invoker + - Update_API_Invoker: Corresponds to update_Invoker() - - Offboard_API_Invoker + - Offboard_API_Invoker Corresponds to offboard_and_deregister_Invoker() -- CAPIF_API_Provider_Management_API +- [CAPIF_API_Provider_Management_API](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_CAPIF_API_Provider_Management_API.yaml) - - Onboard_API_Provider + - Onboard_API_Provider: Corresponds to register_and_onboard_provider() - - Update_API_Provider + - Update_API_Provider: Corresponds to update_service() - - Offboard_API_Provider + - Offboard_API_Provider: Corresponds to offboard_and_deregister_nef() -- CAPIF_Discover_Service_API +- [CAPIF_Discover_Service_API](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_CAPIF_Discover_Service_API.yaml) - - Discover_Service_API + - Discover_Service_API: Corresponds to discover() -- CAPIF_Publish_Service_API +- [CAPIF_Publish_Service_API](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_CAPIF_Publish_Service_API.yaml) - - Publish_Service_API + - Publish_Service_API: Corresponds to publish_services() - - Unpublish_Service_API + - Unpublish_Service_API: Corresponds to unpublish_service() - - Update_Service_API + - Update_Service_API: Corresponds to update_service() - - Get_Service_API + - Get_Service_API: Corresponds to get_service() - - Get_All_Service_API + - Get_All_Service_API: Corresponds to get_all_services() +- [CAPIF_Security API](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_CAPIF_Security_API.yaml) + + - Obtain_Authorization: Corresponds to discover() -# Table of Contents + - 1. [OpenCAPIF SDK Features](./doc/sdk-features.md) - 2. [OpenCAPIF SDK Prerequesites](./doc/sdk-prerequesites.md) - 3. [OpenCAPIF SDK Installation](./doc/sdk-installation.md) - 4. [OpenCAPIF SDK Configuration](./doc/sdk-configuration.md) - 5. [OpenCAPIF SDK Usage](./doc/sdk-usage.md) - 6. [OpenCAPIF SDK known issues](./doc/sdk-issues.md) +# Table of Contents + 1. [OpenCAPIF SDK Prerequesites](./doc/sdk-prerequesites.md) + 2. [OpenCAPIF SDK Installation](./doc/sdk-installation.md) + 3. [OpenCAPIF SDK Configuration](./doc/sdk-configuration.md) + 4. [OpenCAPIF SDK Usage](./doc/sdk-usage.md) + 5. [OpenCAPIF SDK known issues](./doc/sdk-issues.md) diff --git a/doc/sdk-prerequesites.md b/doc/sdk-prerequesites.md index eb10a65..6ba335d 100644 --- a/doc/sdk-prerequesites.md +++ b/doc/sdk-prerequesites.md @@ -1,3 +1,8 @@ ## OpenCAPIF SDK 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). +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). + +For developers installation is mandatory to have already installed: + + - pyenv 3.12 + - -- GitLab