Skip to main content

A python client for schemantis api

Project description

schemantis

This the documentation for the Schemantis REST API.

The schemantis package is automatically generated by the OpenAPI Generator project:

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

Requirements.

Python 3.7+

Installation & Usage

This python library package is generated without supporting files like setup.py or requirements files

To be able to use it, you will need these dependencies in your own package that uses this library:

  • urllib3 >= 1.25.3
  • python-dateutil
  • pydantic

Getting Started

In your own code, to use this library to connect and interact with schemantis, you can run the following:

import schemantis
from schemantis.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.schemantis.ca
# See configuration.py for a list of all supported configuration parameters.
configuration = schemantis.Configuration(
    host = "https://api.schemantis.ca"
)

# 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 API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'


# Enter a context with an instance of the API client
with schemantis.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = schemantis.DefaultApi(api_client)
    map_id = 'map_id_example' # str | The ID of the map to retrieve (optional)
    map_name = 'map_name_example' # str | The name of the map to retrieve (optional)

    try:
        # retrieve map with optional configurable formatting
        api_response = api_instance.retrieve_map_get(map_id=map_id, map_name=map_name)
        print("The response of DefaultApi->retrieve_map_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->retrieve_map_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.schemantis.ca

Class Method HTTP request Description
DefaultApi retrieve_map_get GET /retrieve-map retrieve map with optional configurable formatting
DefaultApi update_schema_post POST /update-schema update schema

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

api_key

  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header

Author

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

schemantis-0.0.10.tar.gz (21.4 kB view details)

Uploaded Source

Built Distribution

schemantis-0.0.10-py3-none-any.whl (29.5 kB view details)

Uploaded Python 3

File details

Details for the file schemantis-0.0.10.tar.gz.

File metadata

  • Download URL: schemantis-0.0.10.tar.gz
  • Upload date:
  • Size: 21.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for schemantis-0.0.10.tar.gz
Algorithm Hash digest
SHA256 a4189df6ce70230d0ddd2840a58a48d7ff1eb60f0535c658af530f9b841e564e
MD5 8f52d21cdcd428ab5aee007d1fce0ae5
BLAKE2b-256 db1d7f47df908abdcc3f9006e22c01c744662deb6e56f68cd6de5ff7f84b2a2c

See more details on using hashes here.

File details

Details for the file schemantis-0.0.10-py3-none-any.whl.

File metadata

  • Download URL: schemantis-0.0.10-py3-none-any.whl
  • Upload date:
  • Size: 29.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for schemantis-0.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 9140c082c968c9182f5b96982a3eee4b1ea6f0006d54fc5eb821b66e896b7956
MD5 bd65e3b5522704d548c2890e07948241
BLAKE2b-256 d8df3e308f2c8f9cedefb2d1bdc882bb36309b9133e74176d9e393faea6dfb31

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page