ft3.api.enm module

Api enumerations.

class ApiKeyLocation(*values)

Bases: Enum

ApiKey In Enumeration.

There are three possible locations specified by the in field:

1. header

2. query

3. cookie

header = 'header'

query = 'query'

cookie = 'cookie'

class Component(*values)

Bases: Enum

OpenAPI Components Enumeration.

YAML Definition

components:
    # Reusable schemas (data models)
    schemas:
        ...
    # Reusable path, query, header and cookie parameters
    parameters:
        ...
    # Security scheme definitions (see Authentication)
    securitySchemes:
        ...
    # Reusable request bodies
    requestBodies:
        ...
    # Reusable responses, such as 401 Unauthorized or 400 Bad Request
    responses:
        ...
    # Reusable response headers
    headers:
        ...
    # Reusable examples
    examples:
        ...
    # Reusable links
    links:
        ...
    # Reusable callbacks
    callbacks:
        ...

callbacks = 'callbacks'

examples = 'examples'

headers = 'headers'

links = 'links'

parameters = 'parameters'

requestBodies = 'requestBodies'

responses = 'responses'

schemas = 'schemas'

securitySchemes = 'securitySchemes'

class ContentType(*values)

Bases: Enum

Common content types.

any_ = '*/*'

html = 'text/html'

icon = 'image/x-icon'

json = 'application/json'

png = 'image/png'

text = 'text/plain'

class Format(*values)

Bases: Enum

OpenAPI Type Formats Enumeration.

Maps to python types.

boolean = 'boolean'

byte = 'byte'

date = 'date'

datetime = 'datetime'

double = 'double'

float = 'float'

int32 = 'int32'

uuid = 'uuid'

class Header(*values)

Bases: Enum

Default headers.

accessControlAllowCredentials = 'Access-Control-Allow-Credentials'

accessControlAllowHeaders = 'Access-Control-Allow-Headers'

accessControlMaxAge = 'Access-Control-Max-Age'

accessControlAllowMethods = 'Access-Control-Allow-Methods'

accessControlAllowOrigin = 'Access-Control-Allow-Origin'

connection = 'Connection'

contentLength = 'Content-Length'

contentType = 'Content-Type'

date = 'Date'

class HeaderValue(*values)

Bases: Enum

Default headers.

accessControlAllowCredentials = True

accessControlAllowHeaders = '*'

accessControlMaxAge = 86400

accessControlAllowMethods = '*'

accessControlAllowOrigin = '*'

connection = 'keep-alive'

contentLength = '*'

contentType = 'application/json'

date = "'%Y-%m-%dT%H:%M:%S.%f%z'"

class ParameterLocation(*values)

Bases: Enum

OpenAPI Paramater In Enumeration.

There are four possible parameter locations specified by the in field:

1. path Used together with Path Templating, where the parameter value is actually part of the operation’s URL. This does not include the host or base path of the API. For example, in /items/{itemId}, the path parameter is itemId.

2. query Parameters that are appended to the URL. For example, in /items?id=###, the query parameter is id.

3. header Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive.

4. cookie Used to pass a specific cookie value to the API.

path = 'path'

query = 'query'

header = 'header'

cookie = 'cookie'

class SecurityHTTPScheme(*values)

Bases: Enum

OpenAPI Security HTTP Scheme Enumeration.

basic = 'basic'

bearer = 'bearer'

class SecuritySchemeType(*values)

Bases: Enum

OpenAPI Security Types Enumeration.

http = 'http'

apiKey = 'apiKey'

oauth2 = 'oauth2'

openIdConnect = 'openIdConnect'

class Type(*values)

Bases: Enum

OpenAPI Types Enumeration.

Maps to python types.

array = 'array'

boolean = 'boolean'

integer = 'integer'

null = 'null'

number = 'number'

object = 'object'

string = 'string'

class Boolean(*values)

Bases: Enum

Boolean Enumeration.

true = True

false = False

class NoneAlias(*values)

Bases: Enum

Nones Enumeration.

null = None

none = None

nan = None