vex-api-client 1.0.0

FastAPI

vex-api-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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

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

Requirements.

Python 3.7+

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 vex_api_client

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 vex_api_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import vex_api_client
from vex_api_client.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 = vex_api_client.Configuration(
    host = "http://localhost"
)

# 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: JWTBearer
configuration = vex_api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with vex_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = vex_api_client.ListApi(api_client)
    org_name = 'org_name_example' # str | 

    try:
        # List Indexes
        api_response = api_instance.list_indexes_v1_indexes_org_name_get(org_name)
        print("The response of ListApi->list_indexes_v1_indexes_org_name_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ListApi->list_indexes_v1_indexes_org_name_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
ListApi	list_indexes_v1_indexes_org_name_get	GET /v1/indexes/{org_name}	List Indexes
SearchApi	search_index_v1_search_org_name_index_name_post	POST /v1/search/{org_name}/{index_name}	Search Index

Documentation For Models

• HTTPValidationError
• IndexSearchResultEntrySchema
• LocationInner
• SearchQueryBody
• SearchResponse
• ValidationError

Documentation For Authorization

Authentication schemes defined for the API:

JWTBearer

• Type: Bearer authentication

Author