bovid.endpoints.custom_fields module

Endpoints related to molecule fields.

class bovid.endpoints.custom_fields.CustomFieldListingHTTPEndpoint

Bases: AnnotatedHTTPEndpoint

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

async get(request)

Parameters:

• self (AnnotatedHTTPEndpoint)

• request (Request)

Return type:

JSONSerializedResponse

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

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

async put(request)

Parameters:

• self (AnnotatedHTTPEndpoint)

• request (Request)

Return type:

JSONSerializedResponse

class bovid.endpoints.custom_fields.CustomFieldHTTPEndpoint

Bases: AnnotatedHTTPEndpoint

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

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

GET_RESPONSES: ResponseSpec = {200: ResponseBodySpec(datatype=<class 'bovid.endpoints.custom_fields.CustomFieldFetchResult'>, 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.custom_fields.CustomFieldDeleteResult'>, media_types=frozenset({<MediaType.json: 'application/json'>}), description='OK')}

async delete(request)

Parameters:

• self (AnnotatedHTTPEndpoint)

• request (Request)

Return type:

JSONSerializedResponse

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

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

async patch(request)

Parameters:

• self (AnnotatedHTTPEndpoint)

• request (Request)

Return type:

JSONSerializedResponse