ourskyai_node_platform_api 1.3.0

OurSky

ourskyai-node-platform-api

Fully merged Converged Node Platform API documentation

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.3.0
• Package version: 1.3.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

pip install ourskyai_node_platform_api

(you may need to run pip with root permission: sudo pip install ourskyai_node_platform_api)

Poetry install

If you manage dependencies with poetry then you can add the SDK with:

poetry add ourskyai_node_platform_api

Import the package

Then import the package:

import ourskyai_node_platform_api

Getting Started

Please follow the installation procedure and then run the following:

import os
import ourskyai_node_platform_api
from ourskyai_node_platform_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8080
# See configuration.py for a list of all supported configuration parameters.
configuration = ourskyai_node_platform_api.Configuration(
    host = "http://localhost:8080"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: BearerToken
configuration = ourskyai_node_platform_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with ourskyai_node_platform_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ourskyai_node_platform_api.DefaultApi(api_client)
    lineage_id = 'lineage_id_example' # str | Optional lineage ID for tracking purposes (optional)

    try:
        api_response = api_instance.v1_get_component_status(lineage_id=lineage_id)
        print("The response of DefaultApi->v1_get_component_status:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->v1_get_component_status: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost:8080/docs/node_platform

Documentation For Authorization

Authentication schemes defined for the API:

BearerToken

• Type: Bearer authentication

Roles

Author