diff --git a/README.md b/README.md index af06075b946ae53f51e15331eb1fc00efc0550d3..370d838b07fa50d9ef59e7d015fa786b8a82ab72 100644 --- a/README.md +++ b/README.md @@ -34,12 +34,14 @@ OpenCAPIF SDK brings a set of functions to integrate with the 5G Core's function | registrations (PUT) | update_provider() | | registrations (DELETE) | offboard_provider() | | allServiceAPIs (GET) | discover() | +| trustedInvokers (PUT//POST) | discover() | +| securities/{securityId}/token | get_tokens() | | service-apis (POST) | publish_services() | | service-apis (DELETE) | unpublish_service() | | service-apis (PUT) | update_service() | | service-apis (GET) | get_service() | | service-apis (GET) | get_all_services() | -| trustedInvokers (PUT//POST) | 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) @@ -49,4 +51,30 @@ NOTE: Above mentioned CAPIF APIs are defined in these 3GPP references: - [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 +NetApp typical flow showcasing SDK usage. + +## As an invoker + +For performing this path it is necesary to: + +1. Create an invoker object -> CAPIFInvokerConnector(config_file=utilities.get_config_file()) + +2. Run onboard_invoker() + +3. Create a service discover object -> ServiceDiscoverer(config_file=utilities.get_config_file()) + +3. Run discover() + +4. Run get_tokens() + + + +## As a provider + +1. Create a provider object -> CAPIFProviderConnector(config_file=utilities.get_config_file()) + +2. Run onboard_provider() + +3. Run publish_services() + + \ No newline at end of file diff --git a/doc/images/Flujo completo-INVOKER PATH.jpg b/doc/images/Flujo completo-INVOKER PATH.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2c591d0c7b41767fa010cbe02e0f30264333a009 Binary files /dev/null and b/doc/images/Flujo completo-INVOKER PATH.jpg differ diff --git a/doc/images/Flujo completo-PROVIDER PATH.jpg b/doc/images/Flujo completo-PROVIDER PATH.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4b33889c8b2ed7d3268bab39c731945c62b7cf12 Binary files /dev/null and b/doc/images/Flujo completo-PROVIDER PATH.jpg differ diff --git a/doc/sdk-usage.md b/doc/sdk-usage.md index ff1a8b661dd309c2c49005ca211c5b48f1ccb043..94da16b46f3f1bd66e969893300a1e128b958476 100644 --- a/doc/sdk-usage.md +++ b/doc/sdk-usage.md @@ -28,14 +28,14 @@ CAPIF is designed to use using two different roles: The common path to follow using CAPIF in order to get an API token of the service it's wanted to use is by following this steps: -- register_and_onboard_Invoker() // Script invoker_capif_connector.py +- onboard_invoker() // Script invoker_capif_connector.py Simplifies the process of onboarding for Invoker users  - discover() // Script invoker_service_discover.py -In this functionality it could be used [Discover_filter.json](./sdk-configuration.md) to retrieve only the access of the API's it's wanted to access +In this functionality it could be used [discover_filter](./sdk-configuration.md) to retrieve only the access of the API's it's wanted to access  @@ -45,7 +45,7 @@ After the Discovery, this functionality simplifies the way of getting created th  -- update_Invoker() and offboard_and_deregister_Invoker() // invoker_capif_connector_update.py and invoker_capif_connector_offboarding.py +- update_invoker() and offboard_and_deregister_Invoker() // invoker_capif_connector_update.py and invoker_capif_connector_offboarding.py For using this features we must have onboard as an invoker previusly. @@ -64,7 +64,7 @@ In the `invoker_folder`, it will be located several folders with each `capif_use # As an provider The common path to follow using CAPIF in order to publish an API is by following this steps: -- register_and_onboard_provider() // Script provider_capif_connector.py +- onboard_provider() // Script provider_capif_connector.py Simplifies the process of onboarding for Provider users,also has the capability to register several APF's and AEF's if its necesary @@ -74,7 +74,7 @@ Simplifies the process of onboarding for Provider users,also has the capability For using the Publish Service is mandatory to fullfill certain fields of the [Publish.json](./sdk-configuration.md) file -- publish_services(service_api_description_json_full_path) // Script provider_publish_api.py +- publish_services() // Script provider_publish_api.py 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 @@ -82,7 +82,7 @@ For using the Publish Service is mandatory to fullfill certain fields of the [Pu - PublisherAPFid - PublisherAEFsids -- unpublish_service(service_api_description_json_full_path) // Script provider_unpublish_api.py +- unpublish_service() // Script provider_unpublish_api.py Simplifies the process of deleting an API @@ -117,7 +117,7 @@ For using the Publish Service is mandatory to fullfill certain fields of the [Pu  -- update_provider() and offboard_and_deregister_provider() // provider_capif_connector_update.py and provider_capif_connector_offboarding.py +- update_provider() and offboard_provider() // provider_capif_connector_update.py and provider_capif_connector_offboarding.py For using this features we must have onboard as a provider previusly.