bovid.endpoints.molecules module

Endpoints related to molecules.

class bovid.endpoints.molecules.MoleculeListingHTTPEndpoint

Bases: AnnotatedHTTPEndpoint

GET_RESPONSES: ResponseSpec = {200: ResponseBodySpec(datatype=<class 'bovid.endpoints.molecules.MoleculeListingResult'>, 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.molecules.MoleculesPutPayload'>, media_types=frozenset({<MediaType.json: 'application/json'>}), description=None, required=True)
PUT_RESPONSES: ResponseSpec = {200: ResponseBodySpec(datatype=<class 'bovid.endpoints.molecules.MoleculePutResult'>, media_types=frozenset({<MediaType.json: 'application/json'>}), description='OK')}
async put(request)
Parameters:

  • self (AnnotatedHTTPEndpoint)

  • request (Request)

Return type:

JSONSerializedResponse

class bovid.endpoints.molecules.MoleculeHTTPEndpoint

Bases: AnnotatedHTTPEndpoint

PARAMS: frozenset[ParamSpec] = frozenset({ParamSpec(name='molecule_id', location=<OpenAPIParameterLocation.path: 'path'>, style=<OpenAPIParameterStyle.simple: 'simple'>, datatype=list[int], description='ID for a molecule in the data store', required=True, explode=False)})
PATH_PARAMS_ORDER: list[str] = ['molecule_id']
GET_RESPONSES: ResponseSpec = {200: ResponseBodySpec(datatype=<class 'bovid.endpoints.molecules.MoleculeFetchResult'>, 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.molecules.MoleculeDeleteResult'>, 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.molecules.MoleculesPutPayload'>, media_types=frozenset({<MediaType.json: 'application/json'>}), description=None, required=True)
PATCH_RESPONSES: ResponseSpec = {200: ResponseBodySpec(datatype=<class 'bovid.endpoints.molecules.MoleculePatchResults'>, media_types=frozenset({<MediaType.json: 'application/json'>}), description='OK')}
async patch(request)
Parameters:

  • self (AnnotatedHTTPEndpoint)

  • request (Request)

Return type:

JSONSerializedResponse