improved intro

README.md

@@ -12,47 +12,31 @@ Current version of OpenCAPIF SDK is compatible with following publicly available
 - [OpenCAPIF Release 1.0](https://ocf.etsi.org/documentation/v1.0.0-release/)
 
 
-# OpenCAPIF SDK Features
-
-This section shows the features available for using CAPIF SDK and its functions in order to import the sdk into another program. 
-
-- [CAPIF_API_Invoker_management API](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_CAPIF_API_Invoker_Management_API.yaml)
-
-    - Onboard_API_Invoker: Corresponds to register_and_onboard_Invoker() 
-
-    - Update_API_Invoker: Corresponds to update_Invoker()
-
-    - Offboard_API_Invoker Corresponds to offboard_and_deregister_Invoker()
-
-- [CAPIF_API_Provider_Management_API](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_CAPIF_API_Provider_Management_API.yaml)
-
-    - Onboard_API_Provider: Corresponds to register_and_onboard_provider()
-
-    - Update_API_Provider: Corresponds to update_service()
-
-    - Offboard_API_Provider: Corresponds to offboard_and_deregister_nef()
-
-- [CAPIF_Discover_Service_API](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_CAPIF_Discover_Service_API.yaml)
-
-    - Discover_Service_API: Corresponds to discover()
-
-- [CAPIF_Publish_Service_API](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_CAPIF_Publish_Service_API.yaml)
-
-    - Publish_Service_API: Corresponds to publish_services(service_api_description_json_full_path)
-
-    - Unpublish_Service_API: Corresponds to unpublish_service(service_api_description_json_full_path)
-
-    - Update_Service_API: Corresponds to update_service(service_api_description_json_full_path)
-
-    - Get_Service_API: Corresponds to get_service()
-
-    - 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()
-
-    
+# OpenCAPIF SDK features
+
+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)                        | register_and_onboard_Invoker()                              |
+| Update_API_Invoker                              | update_Invoker()                                            |
+| Offboard_API_Invoker                            | offboard_and_deregister_Invoker()                           |
+| Onboard_API_Provider                            | register_and_onboard_provider()                             |
+| Update_API_Provider                             | update_service()                                            |
+| Offboard_API_Provider                           | offboard_and_deregister_nef()                               |
+| Discover_Service_API                            | discover()                                                  |
+| Publish_Service_API                             | publish_services(service_api_description_json_full_path)    |
+| Unpublish_Service_API                           | unpublish_service(service_api_description_json_full_path)   |
+| Update_Service_API                              | update_service(service_api_description_json_full_path)      |
+| Get_Service_API                                 | get_service()                                               |
+| Get_All_Service_API                             | get_all_services()                                          |
+| Obtain_Authorization                            | 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)
+- [CAPIF Provider API specification](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_CAPIF_API_Provider_Management_API.yaml)
+- [CAPIF Discover API specification](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_CAPIF_Discover_Service_API.yaml)
+- [CAPIF Publish API specification](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_CAPIF_Publish_Service_API.yaml) 
 
 # Table of Contents
  1. [OpenCAPIF SDK Prerequeriments](./doc/sdk-prerequirements.md)

installation/requirements.txt

@@ -5,7 +5,7 @@ certifi==2024.7.4
 cffi==1.16.0
 chardet==5.2.0
 charset-normalizer==3.3.2
-click==8.0.1
+click==8.1.3
 cookiecutter==2.1.1
 coverage==4.5.4
 cryptography==38.0.4