Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions api/server.py
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ async def lookup_curies_get(
ge=0
)] = 0,
limit: Annotated[int, Query(
description="The number of results to skip. Can be used to page through the results of a query.",
description="The number of results to return. Can be used to page through the results of a query.",
# Limit should be greater than or equal to zero and less than or equal to 1000.
ge=0,
le=1000
Expand Down Expand Up @@ -345,7 +345,7 @@ async def lookup_curies_post(
ge=0
)] = 0,
limit: Annotated[int, Query(
description="The number of results to skip. Can be used to page through the results of a query.",
description="The number of results to return. Can be used to page through the results of a query.",
# Limit should be greater than or equal to zero and less than or equal to 1000.
ge=0,
le=1000
Expand Down Expand Up @@ -638,7 +638,7 @@ class NameResQuery(BaseModel):
)
limit: Optional[int] = Field(
10,
description="The number of results to skip. Can be used to page through the results of a query.",
description="The number of results to return. Can be used to page through the results of a query.",
# Limit should be greater than or equal to zero and less than or equal to 1000.
ge=0,
le=1000
Expand Down
2 changes: 1 addition & 1 deletion documentation/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ Search for cliques by a fragment of a name or synonym.
- `autocomplete` (optional, boolean, default: false): If `true`, treats the input string as incomplete and looks for terms that start with the final word. If `false`, treats the entire phrase as complete (entity linker mode).
- `highlighting` (optional, boolean, default: false): If `true`, returns information on which labels and synonyms matched the search query.
- `offset` (optional, integer, default: 0, minimum: 0): The number of results to skip. Used for pagination.
- `limit` (optional, integer, default: 10, minimum: 0, maximum: 1000): The maximum number of results to return. Used for pagination.
- `limit` (optional, integer, default: 10, minimum: 0, maximum: 1000): The number of results to return. Used for pagination.
- `biolink_type` (optional, list of strings): Filter results to specific Biolink types. Types can be specified with or without the `biolink:` prefix (e.g., `biolink:Disease` or `Disease`). Multiple types are combined with OR logic, so filtering for `PhenotypicFeature` and `Disease` will return concepts that are either phenotypic features OR diseases.
- `only_prefixes` (optional, string): Pipe-separated, case-sensitive list of CURIE prefixes to include (e.g., `MONDO|EFO`). Only results with matching prefixes will be returned.
- `exclude_prefixes` (optional, string): Pipe-separated, case-sensitive list of CURIE prefixes to exclude (e.g., `UMLS|EFO`). Results with matching prefixes will be filtered out.
Expand Down
Loading