Python client

API version: 0.1.0

Requirements

• Python 3.10+
• Docker engine. Documentation

Installation & Usage

1. If you don't have Poetry installed run:

pip install poetry

2. Install dependencies:

poetry config virtualenvs.in-project true
poetry install --no-root

3. Running tests:

poetry run pytest

You can test the application for multiple versions of Python. To do this, you need to install the required Python versions on your operating system, specify these versions in the tox.ini file, and then run the tests:

poetry run tox

Add the tox.ini file to client/.openapi-generator-ignore so that it doesn't get overwritten during client generation.

4. Building package:

poetry build

5. Publishing

poetry config pypi-token.pypi <pypi token>
poetry publish

Client generator

To generate the client, execute the following script from the project root folder

poetry --directory server run python ./tools/client_generator/generate.py ./api/openapi.yaml

Command

generate.py <file> [--asyncio]

Arguments

file Specifies the input OpenAPI specification file path or URL. This argument is required for generating the Python client. The input file can be either a local file path or a URL pointing to the OpenAPI schema.

--asyncio Flag to indicate whether to generate asynchronous code. If this flag is provided, the generated Python client will include asynchronous features. By default, synchronous code is generated.

Configuration

You can change the name of the client package in the file /tools/client_generator/config.json.

Add file's paths to client/.openapi-generator-ignore so that it doesn't get overwritten during client generation.

Examples

python generate.py https://<domain>/openapi.json
python generate.py https://<domain>/openapi.json --asyncio
python generate.py /<path>/openapi.yaml
python generate.py /<path>/openapi.yaml --asyncio

Getting Started

Please follow the installation procedure and then run the following:

import ds_connector_service
from ds_connector_service.rest import ApiException
from pprint import pprint

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



# Enter a context with an instance of the API client
with ds_connector_service.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ds_connector_service.ContractsApi(api_client)
    body = None # object | 

    try:
        # Validate Contract
        api_response = api_instance.validate_contract(body)
        print("The response of ContractsApi->validate_contract:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ContractsApi->validate_contract: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
ContractsApi	validate_contract	POST /contracts/validate	Validate Contract
DataProductsApi	create_data_product	POST /data-products/	Create Data Product
DataProductsApi	delete_data_product	DELETE /data-products/{connector_id}/{data_product_id}/	Delete Data Product
DataProductsApi	get_data_product	GET /data-products/{connector_id}/{data_product_id}/	Get Data Product
DataProductsApi	get_data_product_content	GET /data-products/{connector_id}/{data_product_id}/content	Get Data Product Content
DataProductsApi	list_data_products	GET /data-products/	List Data Products
HealthApi	health_check	GET /health-check/	Health Check
MonitoringApi	get_metrics	GET /metrics	Metrics
TransactionsApi	log_transaction	POST /transactions/	Log Transaction

Documentation For Models

• HTTPValidationError
• ValidationError
• ValidationErrorLocInner

Documentation For Authorization

Endpoints do not require authorization.

Author

all-hiro@hiro-microdatacenters.nl