Commit 047acede authored by JorgeEcheva26's avatar JorgeEcheva26
Browse files

Snake case and references to swaggers

parent 22d0fbfd

README.md

+14 −14
Original line number Diff line number Diff line
@@ -27,26 +27,26 @@ OpenCAPIF SDK brings a set of functions to integrate with the 5G Core's function 


| **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()                                                  |

| onboardedInvokers (POST)                        | onboard_invoker()                                           |

| onboardedInvokers (PUT)                         | update_invoker()                                            |

| onboardedInvokers (DELETE)                      | offboard_invoker()                                          |

| registrations (POST)                            | onboard_provider()                                          |

| registrations (PUT)                             | update_provider()                                           |

| registrations (DELETE)                          | offboard_provider()                                         |

| allServiceAPIs (GET)                            | discover()                                                  |

| service-apis (POST)                             | publish_services(service_api_description_json_full_path)    |

| service-apis (DELETE)                           | unpublish_service(service_api_description_json_full_path)   |

| service-apis (PUT)                              | update_service(service_api_description_json_full_path)      |

| service-apis (GET)                              | get_service()                                               |

| service-apis (GET)                              | get_all_services()                                          |

| trustedInvokers (PUT)                           | 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) 



- [CAPIF Security API specification](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_CAPIF_Security_API.yaml)

# NetApp developer path



NetApp typical flow showcasing SDK usage. WIP
 
 No newline at end of file

doc/sdk-usage.md

+1 −1
Original line number Diff line number Diff line
@@ -6,7 +6,7 @@ Before usage it's needed to have completed the [prerequirements](./sdk-prerequir 


IMPORTANT: All jsons configuration files **MUST** be in the same folder



[GENERAL CAPIF USAGE FLOW](./images/Flujo%20completo-OPENCAPIF%20ACTUAL.jpg)

![GENERAL CAPIF USAGE FLOW](./images/Flujo%20completo-OPENCAPIF%20ACTUAL.jpg)



This repository includes 2 different modes to test OpenCAPIF SDK:

scripts/invoker_capif_connector.py

+1 −1
Original line number Diff line number Diff line
@@ -19,7 +19,7 @@ def showcase_capif_connector(): 


    capif_connector = CAPIFInvokerConnector(config_file=utilities.get_config_file())



    capif_connector.register_and_onboard_Invoker()

    capif_connector.register_and_onboard_invoker()

    print("COMPLETED")



if __name__ == "__main__":

scripts/invoker_capif_connector_offboarding.py

+1 −1
Original line number Diff line number Diff line
@@ -15,7 +15,7 @@ from sdk import CAPIFInvokerConnector 


def showcase_offboard_and_deregister_invoker():

    capif_connector = CAPIFInvokerConnector(config_file=utilities.get_config_file())

    capif_connector.offboard_and_deregister_Invoker()

    capif_connector.offboard_and_deregister_invoker()

    print("COMPLETED")

scripts/invoker_capif_connector_update.py

+1 −1
Original line number Diff line number Diff line
@@ -19,7 +19,7 @@ def showcase_capif_connector(): 


    capif_connector = CAPIFInvokerConnector(config_file=utilities.get_config_file())



    capif_connector.update_Invoker()

    capif_connector.update_invoker()

    print("COMPLETED")



if __name__ == "__main__":