ksapi 1.0.0

Knowledge Stack API

ksapi

Knowledge Stack backend API for authentication and knowledge management

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

• API version: 0.1.0
• Package version: 1.0.0
• Generator version: 7.16.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import ksapi

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import ksapi

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import ksapi
from ksapi.rest import ApiException
from pprint import pprint

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



# Enter a context with an instance of the API client
with ksapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ksapi.DefaultApi(api_client)

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

Documentation for API Endpoints

All URIs are relative to http://localhost:8000

Class	Method	HTTP request	Description
DefaultApi	health_check_healthz_get	GET /healthz	Health Check
DefaultApi	root_get	GET /	Root

Documentation For Models

• HealthCheckResponse

Documentation For Authorization

Endpoints do not require authorization.

Author