Skip to content
Snippets Groups Projects
Commit 2f69aa74 authored by JorgeEcheva26's avatar JorgeEcheva26
Browse files

typycal flow

parent 85d8214f
No related branches found
No related tags found
1 merge request!1Sdk v0.1 (#1)
...@@ -34,12 +34,14 @@ OpenCAPIF SDK brings a set of functions to integrate with the 5G Core's function ...@@ -34,12 +34,14 @@ OpenCAPIF SDK brings a set of functions to integrate with the 5G Core's function
| registrations (PUT) | update_provider() | | registrations (PUT) | update_provider() |
| registrations (DELETE) | offboard_provider() | | registrations (DELETE) | offboard_provider() |
| allServiceAPIs (GET) | discover() | | allServiceAPIs (GET) | discover() |
| trustedInvokers (PUT//POST) | discover() |
| securities/{securityId}/token | get_tokens() |
| service-apis (POST) | publish_services() | | service-apis (POST) | publish_services() |
| service-apis (DELETE) | unpublish_service() | | service-apis (DELETE) | unpublish_service() |
| service-apis (PUT) | update_service() | | service-apis (PUT) | update_service() |
| service-apis (GET) | get_service() | | service-apis (GET) | get_service() |
| service-apis (GET) | get_all_services() | | service-apis (GET) | get_all_services() |
| trustedInvokers (PUT//POST) | discover() |
NOTE: Above mentioned CAPIF APIs are defined in these 3GPP references: 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 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: ...@@ -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) - [CAPIF Security API specification](https://github.com/jdegre/5GC_APIs/blob/Rel-18/TS29222_CAPIF_Security_API.yaml)
# NetApp developer path # NetApp developer path
NetApp typical flow showcasing SDK usage. WIP NetApp typical flow showcasing SDK usage.
\ No newline at end of file
## 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()
![INVOKER_PATH](./doc/images/Flujo%20completo-INVOKER%20PATH.jpg)
## As a provider
1. Create a provider object -> CAPIFProviderConnector(config_file=utilities.get_config_file())
2. Run onboard_provider()
3. Run publish_services()
![PROVIDER_PATH](./doc/images/Flujo%20completo-PROVIDER%20PATH.jpg)
\ No newline at end of file
doc/images/Flujo completo-INVOKER PATH.jpg

106 KiB

doc/images/Flujo completo-PROVIDER PATH.jpg

106 KiB

...@@ -28,14 +28,14 @@ CAPIF is designed to use using two different roles: ...@@ -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: 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 Simplifies the process of onboarding for Invoker users
![Invoker_onboard](./images/Invoker_onboarding.png) ![Invoker_onboard](./images/Invoker_onboarding.png)
- discover() // Script invoker_service_discover.py - 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
![Invoker_discover](./images/Invoker_discover.png) ![Invoker_discover](./images/Invoker_discover.png)
...@@ -45,7 +45,7 @@ After the Discovery, this functionality simplifies the way of getting created th ...@@ -45,7 +45,7 @@ After the Discovery, this functionality simplifies the way of getting created th
![Invoker_get_token](./images/invoker_get_token.png) ![Invoker_get_token](./images/invoker_get_token.png)
- 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. 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 ...@@ -64,7 +64,7 @@ In the `invoker_folder`, it will be located several folders with each `capif_use
# As an provider # As an provider
The common path to follow using CAPIF in order to publish an API is by following this steps: 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 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 ...@@ -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 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 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 ...@@ -82,7 +82,7 @@ For using the Publish Service is mandatory to fullfill certain fields of the [Pu
- PublisherAPFid - PublisherAPFid
- PublisherAEFsids - 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 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 ...@@ -117,7 +117,7 @@ For using the Publish Service is mandatory to fullfill certain fields of the [Pu
![Provider_publish](./images/provider_publish.png) ![Provider_publish](./images/provider_publish.png)
- 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. For using this features we must have onboard as a provider previusly.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment