bovid.endpoints.db_smoke module

class bovid.endpoints.db_smoke.SmokePutPayload

Bases: Model

smoke: Smoke

__init__(smoke)

Method generated by attrs for class SmokePutPayload.

Parameters:

smoke (Smoke)

Return type:

None

class bovid.endpoints.db_smoke.SmokePutResult

Bases: Model

success: bool

already_in_db: bool

smoke_id: int

__init__(success, already_in_db, smoke_id)

Method generated by attrs for class SmokePutResult.

Parameters:

• success (bool)

• already_in_db (bool)

• smoke_id (int)

Return type:

None

class bovid.endpoints.db_smoke.SmokeListingResult

Bases: Model

records: Sequence[SmokeRecord]

__init__(records)

Method generated by attrs for class SmokeListingResult.

Parameters:

records (Sequence[SmokeRecord])

Return type:

None

class bovid.endpoints.db_smoke.SmokeFetchResult

Bases: Model

success: bool

smoke: Smoke | None

__init__(success, smoke)

Method generated by attrs for class SmokeFetchResult.

Parameters:

• success (bool)

• smoke (Smoke | None)

Return type:

None

class bovid.endpoints.db_smoke.SmokeDeleteResult

Bases: Model

success: bool

__init__(success)

Method generated by attrs for class SmokeDeleteResult.

Parameters:

success (bool)

Return type:

None

class bovid.endpoints.db_smoke.SmokeUpdatePayload

Bases: Model

smoke: Smoke

__init__(smoke)

Method generated by attrs for class SmokeUpdatePayload.

Parameters:

smoke (Smoke)

Return type:

None

class bovid.endpoints.db_smoke.SmokeUpdateResult

Bases: Model

success: bool

__init__(success)

Method generated by attrs for class SmokeUpdateResult.

Parameters:

success (bool)

Return type:

None

class bovid.endpoints.db_smoke.SmokeListingHTTPEndpoint

Bases: AnnotatedHTTPEndpoint

PUT_REQUEST_BODY: RequestBodySpec | None = RequestBodySpec(datatype=<class 'bovid.endpoints.db_smoke.SmokePutPayload'>, media_types=frozenset({<MediaType.json: 'application/json'>}), description=None, required=True)

PUT_RESPONSES: ResponseSpec = {200: ResponseBodySpec(datatype=<class 'bovid.endpoints.db_smoke.SmokePutResult'>, media_types=frozenset({<MediaType.json: 'application/json'>}), description='OK')}

async put(request)

Parameters:

• self (AnnotatedHTTPEndpoint)

• request (Request)

Return type:

JSONSerializedResponse

GET_RESPONSES: ResponseSpec = {200: ResponseBodySpec(datatype=<class 'bovid.endpoints.db_smoke.SmokeListingResult'>, media_types=frozenset({<MediaType.json: 'application/json'>}), description='OK')}

async get(request)

Parameters:

• self (AnnotatedHTTPEndpoint)

• request (Request)

Return type:

JSONSerializedResponse

class bovid.endpoints.db_smoke.SmokeHTTPEndpoint

Bases: AnnotatedHTTPEndpoint

PARAMS: frozenset[ParamSpec] = frozenset({ParamSpec(name='key', location=<OpenAPIParameterLocation.path: 'path'>, style=<OpenAPIParameterStyle.simple: 'simple'>, datatype=<class 'int'>, description='ID for a smoke', required=True, explode=False)})

PATH_PARAMS_ORDER: list[str] = ['key']

GET_RESPONSES: ResponseSpec = {200: ResponseBodySpec(datatype=<class 'bovid.endpoints.db_smoke.SmokeFetchResult'>, media_types=frozenset({<MediaType.json: 'application/json'>}), description='OK')}

async get(request)

Parameters:

• self (AnnotatedHTTPEndpoint)

• request (Request)

Return type:

JSONSerializedResponse

DELETE_RESPONSES: ResponseSpec = {200: ResponseBodySpec(datatype=<class 'bovid.endpoints.db_smoke.SmokeDeleteResult'>, media_types=frozenset({<MediaType.json: 'application/json'>}), description='OK')}

async delete(request)

Parameters:

• self (AnnotatedHTTPEndpoint)

• request (Request)

Return type:

JSONSerializedResponse

PUT_REQUEST_BODY: RequestBodySpec | None = RequestBodySpec(datatype=<class 'bovid.endpoints.db_smoke.SmokeUpdatePayload'>, media_types=frozenset({<MediaType.json: 'application/json'>}), description=None, required=True)

PUT_RESPONSES: ResponseSpec = {200: ResponseBodySpec(datatype=<class 'bovid.endpoints.db_smoke.SmokeUpdateResult'>, media_types=frozenset({<MediaType.json: 'application/json'>}), description='OK')}

async put(request)

Parameters:

• self (AnnotatedHTTPEndpoint)

• request (Request)

Return type:

JSONSerializedResponse