Commit 79af8549 authored by Daniel García's avatar Daniel García
Browse files

Improved structure and editing of sdk-usage documentation. Fix spelling.

parent 03507b10
Loading
Loading
Loading
Loading
+62 −28
Original line number Diff line number Diff line
@@ -55,12 +55,13 @@ In the `provider_folder`, it will be located several folders with each `capif_us
- `published-apis.json` : Contains the currently published APIs with their ApiId


### onboard_provider() // Script provider_capif_connector.py
### Provider onboarding

**CAPIF SDK function**: <mark>onboard_provider()</mark>\
**CAPIF SDK script**: <mark>provider_capif_connector.py</mark>
CAPIF SDK references:
* **CAPIF SDK function**: <mark>onboard_provider()</mark>\
* **CAPIF SDK script**: <mark>provider_capif_connector.py</mark>

Simplifies the onboarding process for Provider developers. It also provides the capability to register several APFs and AEFs if necessary.
SDK simplifies the onboarding process for Provider developers. It also provides the capability to register several APFs and AEFs if necessary.

![Provider_onboard](./images/provider_onboarding.png)

@@ -68,19 +69,27 @@ Simplifies the onboarding process for Provider developers. It also provides the

Using Publish Service it is required to fulfill certain fields of the [capif-sdk-config.json](./sdk-configuration.md) file.

### publish_services() // Script provider_publish_api.py
### Services publishing

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.
CAPIF SDK references:
* **CAPIF SDK function**: <mark>publish_services()</mark>\
* **CAPIF SDK script**: <mark>provider_publish_api.py</mark>

It is mandatory to have [onboarded as a provider](#onboard_provider--script-provider_capif_connectorpy) before 
SDK simplifies the process of publishing an API in CAPIF. Besides, it also provides the ability to chose which APF and AEFs will be used to publish the API.

It is mandatory to be [onboarded as a provider](#onboard_provider--script-provider_capif_connectorpy):

    Mandatory fields:
    - PublisherAPFid
    - PublisherAEFsids

### unpublish_service() // Script provider_unpublish_api.py
### Services deletion

CAPIF SDK references:
* **CAPIF SDK function**: <mark>unpublish_service()</mark>\
* **CAPIF SDK script**: <mark>provider_unpublish_api.py</mark>

Simplifies the process of deleting an API available in CAPIF:
SDK simplifies the process of deleting an API available in CAPIF.

It is mandatory to have onboarded as a [provider](#onboard_provider--script-provider_capif_connectorpy) before and to have [published any service](#publish_services--script-provider_publish_apipy) before 

@@ -89,9 +98,13 @@ It is mandatory to have onboarded as a [provider](#onboard_provider--script-prov
    - PublisherAPFid
    - PublisherAEFsids

### update_service() // Script provider_update_api.py
### Services update

CAPIF SDK references:
* **CAPIF SDK function**: <mark>update_service()</mark>\
* **CAPIF SDK script**: <mark>provider_update_api.py</mark>

Simplifies the process of updating an API. Also has the capability to chose which APF and AEF's will be used to update the API.
SDK simplifies the process of updating an API already registered at CAPIF. It also supports selecting which APF and AEFs will be used to update the API.

It is mandatory to have onboarded as a [provider](#onboard_provider--script-provider_capif_connectorpy) before and to have [published any service](#publish_services--script-provider_publish_apipy) before

@@ -100,9 +113,13 @@ It is mandatory to have onboarded as a [provider](#onboard_provider--script-prov
    - PublisherAPFid
    - PublisherAEFsids

### get_service() // Script provider_get_published_api.py
### Get services

Simplifies the process of receiving the information of One service published previously in published-apis.json
CAPIF SDK references:
* **CAPIF SDK function**: <mark>get_service()</mark>\
* **CAPIF SDK script**: <mark>provider_get_published_api.py</mark>

SDK simplifies the process of receiving the information of one service published previously in published-apis.json

It is mandatory to have onboarded as a [provider](#onboard_provider--script-provider_capif_connectorpy) before and to have [published any service](#publish_services--script-provider_publish_apipy) before

@@ -110,9 +127,13 @@ It is mandatory to have onboarded as a [provider](#onboard_provider--script-prov
    - ServiceApiId
    - PublisherAPFid

### get_all_services() // Script provider_get_all_published_api.py
### Get all services

CAPIF SDK references:
* **CAPIF SDK function**: <mark>get_all_services()</mark>\
* **CAPIF SDK script**: <mark>provider_get_all_published_api.py</mark>

Simplifies the process of receiving the information of all available services published previously in published-apis.json
SDK simplifies the process of receiving the information of all available services published previously in published-apis.json

It is mandatory to have onboarded as a [provider](#onboard_provider--script-provider_capif_connectorpy) before and to have [published any service](#publish_services--script-provider_publish_apipy) before

@@ -121,11 +142,13 @@ It is mandatory to have onboarded as a [provider](#onboard_provider--script-prov

![Provider_publish](./images/provider_publish.png)

### update_provider() and offboard_provider() // provider_capif_connector_update.py and provider_capif_connector_offboarding.py
### Update and Offboard provider

For using this features we must have onboard as a provider previously.
CAPIF SDK references:
* **CAPIF SDK function**: <mark>update_provider()</mark> & <mark>offboard_provider()</mark>
* **CAPIF SDK script**: <mark>provider_capif_connector_update.py</mark> & <mark>provider_capif_connector_offboarding.py</mark>

It is mandatory to have onboarded as a [provider](#onboard_provider--script-provider_capif_connectorpy) before
For using this features we must be previously onboarded as a provider.

![Provider_update-offboard](./images/provider_update-offboard.png)

@@ -149,10 +172,15 @@ Simplifies the process of onboarding for Invoker users

![Invoker_onboard](./images/Invoker_onboarding.png)

### discover() // Script invoker_service_discover.py
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 query
### Discover process

CAPIF SDK references:
* **CAPIF SDK function**: <mark>discover()</mark>\
* **CAPIF SDK script**: <mark>invoker_service_discover.py</mark>

It is mandatory to have onboarded as a [invoker](#onboard_invoker--script-invoker_capif_connectorpy) before
In this functionality, [discover_filter](./sdk-configuration.md) is used to retrieve the access of target API specified in discover filter.

It is mandatory to be onboarded as a [invoker](#onboard_invoker--script-invoker_capif_connectorpy).

DISCLAIMER: if it's the first time the user runs discover() it will appear a warning alert like this

@@ -160,21 +188,27 @@ DISCLAIMER: if it's the first time the user runs discover() it will appear a war
    
![Invoker_discover](./images/Invoker_discover.png)

### get_tokens() // Script invoker_service_get_token.py
### Obtain Invoker tokens

CAPIF SDK references:
* **CAPIF SDK function**: <mark>get_tokens()</mark>\
* **CAPIF SDK script**: <mark>invoker_service_get_token.py</mark>

This functionality simplifies the way of getting created their properly security context for each of the services and acquiring the access token to use the final APIs.
This functionality simplifies the process of creating a security context based on JWT tokens in CAPIF, allowing to access the target APIs.

This functionality **requires** to to have onboarded as a [invoker](#onboard_invoker--script-invoker_capif_connectorpy) before and run the [discover](#discover--script-invoker_service_discoverpy) function at least once before.
This functionality **requires** to to be onboarded as a [invoker](#onboard_invoker--script-invoker_capif_connectorpy) before and run the [discover](#discover--script-invoker_service_discoverpy) function at least once before.

![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 & offboard invoker

For using this features we must have [onboarded as an invoker](#onboard_invoker--script-invoker_capif_connectorpy) previously.

![Invoker_update-offboard](./images/invoker_update-offboard.png)
CAPIF SDK references:
* **CAPIF SDK function**: <mark>update_invoker()</mark> & <mark>offboard_and_deregister_Invoker()</mark>
* **CAPIF SDK script**: <mark>invoker_capif_connector_update.py</mark> & <mark>invoker_capif_connector_offboarding.py</mark>

To use these features, the NetApp must be previously [onboarded as an invoker](#onboard_invoker--script-invoker_capif_connectorpy).

![Invoker_update-offboard](./images/invoker_update-offboard.png)

# Other features