bunker 1.0.1

Bunker OpenAPI Specification

openapi-client

An OpenAPI specification for Bunker Service

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

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

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

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 openapi_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 openapi_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = openapi_client.BunkerApi(openapi_client.ApiClient(configuration))
person = openapi_client.Person() # Person | The user to create (optional)

try:
    api_response = api_instance.create_person(person=person)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BunkerApi->create_person: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost:8080/v1

Class	Method	HTTP request	Description
BunkerApi	create_person	POST /persons
BunkerApi	delete_document	DELETE /persons/{person_id}/documents/{document_id}
BunkerApi	delete_face	DELETE /persons/{person_id}/faces/{face_id}
BunkerApi	delete_person	DELETE /persons/{person_id}
BunkerApi	delete_scan	DELETE /persons/{person_id}/scans/{scan_id}
BunkerApi	get_document	GET /persons/{person_id}/documents/{document_id}
BunkerApi	get_face	GET /persons/{person_id}/faces/{face_id}
BunkerApi	get_person	GET /persons/{person_id}
BunkerApi	get_scan	GET /persons/{person_id}/scans/{scan_id}
BunkerApi	request_scan	POST /persons/{person_id}/scans/
BunkerApi	upload_document	POST /persons/{person_id}/documents/
BunkerApi	upload_face	POST /persons/{person_id}/faces/

Documentation For Models

• Document
• ErrorMessage
• Face
• Person
• Scan

Documentation For Authorization

ApiKeyAuth

• Type: API key
• API key parameter name: apikey
• Location: HTTP header

Author