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

Update intros and format.

parent e0c0119d
Loading
Loading
Loading
Loading
+16 −14
Original line number Diff line number Diff line
@@ -23,7 +23,7 @@ This repository includes 2 different modes to test OpenCAPIF SDK:
As explained before, OpenCAPIF SDK is designed to play two different roles:

- [Provider NetApp](#provider-netapp)
    - [Important information for Providers](#important-information-for-provider-consumer)
    - [Important information for Providers](#important-information-for-providers)
    - [Onboard Provider](#onboard_provider--script-provider_capif_connectorpy)
    - [Publish services](#publish_services--script-provider_publish_apipy)
    - [Unpublish services](#unpublish_service--script-provider_unpublish_apipy)
@@ -32,20 +32,20 @@ As explained before, OpenCAPIF SDK is designed to play two different roles:
    - [Get all published services](#get_all_services--script-provider_get_all_published_apipy)
    - [Update and offboard Provider](#update_provider-and-offboard_provider--provider_capif_connector_updatepy-and-provider_capif_connector_offboardingpy)
- [Invoker NetApp](#invoker-netapp)
    - [Important information for Invokers](#important-information-for-invoker-consumer)
    - [Onboard Invoker](#onboard_invoker--script-invoker_capif_connectorpy)
    - [Discover API](#discover--script-invoker_service_discoverpy)
    - [Get tokens](#get_tokens--script-invoker_service_get_tokenpy)
    - [Update and offboard Invoker](#update_invoker-and-offboard_and_deregister_invoker--invoker_capif_connector_updatepy-and-invoker_capif_connector_offboardingpy)
    - [Important information for Invokers](#important-information-for-invokers)
    - [Onboard process](#onboard_invoker--script-invoker_capif_connectorpy)
    - [Discover process](#discover--script-invoker_service_discoverpy)
    - [Get JWT tokens](#get_tokens--script-invoker_service_get_tokenpy)
    - [Update and offboarding process](#update_invoker-and-offboard_and_deregister_invoker--invoker_capif_connector_updatepy-and-invoker_capif_connector_offboardingpy)
- [Other Features](#other-features)
    - [Register and Login](#script-register_and_loginpy)
    - [Deregister and Login](#script-deregister_and_loginpy)

# Provider NetApp

The common path to follow using CAPIF in order to publish an API is by following this steps:
CAPIF SDK allows developers to quickly implement NetApp provider flow in just some code lines. This section contains the full guide of all available features in SDK related to CAPIF providers.

## Important information for Provider consumer
## Important information for Providers

Within the `provider_folder`, the SDK will store some folders named with the provided `capif_username` it has been previously registered from CAPIF administrator. At each folder, there will be found the following files:

@@ -154,21 +154,23 @@ For using this features we must be previously onboarded as a provider.

# Invoker NetApp

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:
CAPIF SDK allows developers to quickly implement NetApp invokers flow in just some code lines. This section contains the full guide of all available features in SDK related to CAPIF invokers.

## Important information for Invoker consumer
## Important information for Invokers

Within the `invoker_folder`, the SDK will store some folders named with the provided `capif_username` it has been previously registered from CAPIF administrator. At each folder, there will be found the following files:


-   `capif_api_security_context_details.json`: This file contains the information of the invoker. It will contain:
        
    1. The `api_invoker_id`.
    2. If it has already used the Service Discovery Functionality, it will be found all the available APIs with their information.
    1. The `api_invoker_id`,
    2. If it has already used the Service Discovery Functionality, it will be found all the available APIs with their information,
    3. If it has already used the Service Get Token functionality, it will be found the access token for using the APIs that has already been discovered.

### Onboarding processs 

### onboard_invoker() // Script invoker_capif_connector.py  
CAPIF SDK references:
* **CAPIF SDK function**: <mark>onboard_invoker()</mark>\
* **CAPIF SDK script**: <mark>invoker_capif_connector.py</mark>

Simplifies the process of onboarding for Invoker users