Commit 248fd219 authored by JorgeEcheva26's avatar JorgeEcheva26
Browse files

Change features

parent eb83d665

README.md

+26 −23
Original line number Diff line number Diff line
@@ -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)

doc/sdk-prerequesites.md

+6 −1
Original line number Diff line number Diff line 
## 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

    -