metakb.schemas.api#

Create schemas for API

class metakb.schemas.api.BatchSearchStatementsResponse(**data)[source]#

Define model for /batch_search_statements HTTP endpoint response.

duration_s: float[source]#
limit: Optional[int][source]#
search_terms: list[SearchTerm][source]#
service_meta_: ServiceMeta[source]#
start: int[source]#
statements: list[Statement][source]#
class metakb.schemas.api.ImplMetadata(**data)[source]#

Define substructure for reporting metadata about internal software dependencies.

cat_vrs_python_version: str[source]#
va_spec_python_version: str[source]#
vrs_python_version: str[source]#
class metakb.schemas.api.SearchResult(**data)[source]#

Results of a search.

Includes both processed search terms and all statements.

limit: Optional[int][source]#
search_terms: list[SearchTerm][source]#
start: int[source]#
statements: list[Statement][source]#
class metakb.schemas.api.SearchStatementsQuery(**data)[source]#

Queries for the Search Statements Endpoint.

disease: Optional[SearchTerm][source]#
gene: Optional[SearchTerm][source]#
statement_id: Optional[SearchTerm][source]#
therapy: Optional[SearchTerm][source]#
variation: Optional[SearchTerm][source]#
class metakb.schemas.api.SearchStatementsResponse(**data)[source]#

Define model for /search_statements HTTP endpoint response.

diagnostic_statements: list[Statement][source]#
duration_s: float[source]#
limit: Optional[int][source]#
prognostic_statements: list[Statement][source]#
query: SearchStatementsQuery[source]#
service_meta_: ServiceMeta[source]#
start: int[source]#
therapeutic_response_statements: list[Statement][source]#
class metakb.schemas.api.SearchTerm(**data)[source]#

Generalized search term with validated/normalized ID.

resolved_id: Optional[str][source]#
resolved_object: UnionType[MappableConcept, CategoricalVariant, None][source]#
term: str[source]#
term_type: SearchTermType[source]#
class metakb.schemas.api.SearchTermType(value, names=_not_given, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Type of term being searched.

DISEASE = 'disease'[source]#
GENE = 'gene'[source]#
STATEMENT_ID = 'statement_id'[source]#
THERAPY = 'therapy'[source]#
VARIATION = 'variation'[source]#
class metakb.schemas.api.ServiceEnvironment(value, names=_not_given, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Define current runtime environment.

DEV = 'dev'[source]#
LOCAL = 'local'[source]#
PROD = 'prod'[source]#
STAGING = 'staging'[source]#
TEST = 'test'[source]#
class metakb.schemas.api.ServiceInfo(**data)[source]#

Define response structure for GA4GH /service_info endpoint.

contactUrl: Literal['Alex.Wagner@nationwidechildrens.org'][source]#
createdAt: Literal['2025-06-01T00:00:00Z'][source]#
description: str[source]#
documentationUrl: Literal['https://github.com/cancervariants/metakb'][source]#
environment: ServiceEnvironment[source]#
id: Literal['org.cancervariants.metakb'][source]#
impl_metadata: ImplMetadata[source]#
name: Literal['metakb'][source]#
organization: ServiceOrganization[source]#
spec_metadata: SpecMetadata[source]#
type: ServiceType[source]#
updatedAt: Literal['2025-06-01T00:00:00Z'][source]#
version: str[source]#
class metakb.schemas.api.ServiceMeta(**data)[source]#

Metadata for MetaKB service.

name: Literal['metakb'][source]#
url: Literal['https://github.com/cancervariants/metakb'][source]#
version: Annotated[str][source]#
class metakb.schemas.api.ServiceOrganization(**data)[source]#

Define service_info response for organization field

name: Literal['Variant Interpretation for Cancer Consortium'][source]#
url: Literal['https://cancervariants.org/'][source]#
class metakb.schemas.api.ServiceType(**data)[source]#

Define service_info response for type field

artifact: Literal['MetaKB API'][source]#
group: Literal['org.cancervariants'][source]#
version: str[source]#
class metakb.schemas.api.SpecMetadata(**data)[source]#

Define substructure for reporting specification metadata.

cat_vrs_version: str[source]#
va_spec_version: str[source]#
vrs_version: str[source]#