Skip to content

Commit 1032e78

Browse files
update a few names, types, and comments for clairity
1 parent 56a8078 commit 1032e78

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

src/anyvlm/restapi/vlm.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@ def ingest_vcf(vcf_path: Path) -> None:
2727

2828

2929
@app.get(
30-
"/vlm-query",
31-
summary="Provides counts of occurrences of a single sequence variant, broken down by zygosity",
32-
description="Search for a single sequence variant and receive a count of its observed occurrences broken down by zygosity, in accordance with the Variant-Level Matching protocol",
30+
"/variant_counts",
31+
summary="Provides allele counts of a single sequence variant, broken down by zygosity",
32+
description="Search for a single sequence variant and receive allele counts by zygosity, in accordance with the Variant-Level Matching protocol",
3333
tags=[EndpointTag.SEARCH],
3434
)
35-
def vlm_query(
35+
def variant_counts(
3636
request: Request,
3737
assemblyId: Annotated[ # noqa: N803
3838
GrcAssemblyId | UscsAssemblyBuild,
@@ -49,7 +49,7 @@ def vlm_query(
4949
GenomicSequence, Query(..., description="Genomic bases ('T', 'AC', etc.)")
5050
],
5151
) -> VlmResponse:
52-
"""Accept a Variant-Level Matching network request and return a count of occurrences of a single sequence variant, broken down by zygosity.
52+
"""Accept a Variant-Level Matching network request and return allele counts by zygosity.
5353
5454
:param request: FastAPI `Request` object
5555
:param assemblyId: The genome reference assembly. Must be a GRC assembly identifier (e.g., "GRCh38) or a USCS assembly build (e.g., "hg38")

src/anyvlm/schemas/vlm.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44

55

66
class VlmResponse(BaseModel):
7-
"""Define response structure for the vlm-query endpoint."""
7+
"""Define response structure for the variant_counts endpoint."""
88

99
# TODO: Fill this in. See Issue #13

src/anyvlm/utils/types.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ def _normalize_chromosome_name(chromosome_name: str) -> str:
6868
if is_valid_chromosome_name(chromosome_name):
6969
return chromosome_name
7070
error_message = (
71-
"Invalid chromosome. Must be 1-22, 'X,' or 'Y,' with optional 'chr' prefix."
71+
"Invalid chromosome. Must be 1-22, 'X', or 'Y'; with optional 'chr' prefix."
7272
)
7373
raise ValueError(error_message)
7474

0 commit comments

Comments
 (0)