falcon_alliance.BaseSchema

class falcon_alliance.BaseSchema

Base class for all schemas.

classmethod add_auth_secret(auth_secret: str) → None

Adds the authentication secret for POST requests to the BaseSchema for all subclasses to access.

Parameters:

auth_secret (str) – Authentication secret given by TBA for POST requests.

classmethod add_headers(headers: dict) → None

Adds headers for subclasses’ uses when sending requests (GET/POST).

Parameters:

headers (dict) – A dictionary that is in the format of {“X-TBA-Auth-Key”: api_key} for TBA be able to authorize sending requests.