Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make get by key default false #910

Merged
merged 2 commits into from Jan 30, 2024
Merged

Make get by key default false #910

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
68446f5
Make get by key default false
munrojm Jan 30, 2024
0e8db92
Fix api tests
munrojm Jan 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/maggma/api/resource/read_resource.py
View file
Open in desktop
Expand Up @@ -34,7 +34,7 @@ def __init__(
hint_scheme: Optional[HintScheme] = None,
header_processor: Optional[HeaderProcessor] = None,
timeout: Optional[int] = None,
enable_get_by_key: bool = True,
enable_get_by_key: bool = False,
enable_default_search: bool = True,
disable_validation: bool = False,
query_disk_use: bool = False,
Expand All @@ -53,7 +53,7 @@ def __init__(
before raising a timeout error
key_fields: List of fields to always project. Default uses SparseFieldsQuery
to allow user to define these on-the-fly.
enable_get_by_key: Enable default key route for endpoint.
enable_get_by_key: Enable get by key route for endpoint.
enable_default_search: Enable default endpoint search behavior.
query_disk_use: Whether to use temporary disk space in large MongoDB queries.
disable_validation: Whether to use ORJSON and provide a direct FastAPI response.
Expand Down
8 changes: 4 additions & 4 deletions tests/api/test_read_resource.py
View file
Open in desktop
Expand Up @@ -41,13 +41,13 @@ def owner_store():


def test_init(owner_store):
resource = ReadOnlyResource(store=owner_store, model=Owner)
resource = ReadOnlyResource(store=owner_store, model=Owner, enable_get_by_key=True)
assert len(resource.router.routes) == 3

resource = ReadOnlyResource(store=owner_store, model=Owner, enable_get_by_key=False)
assert len(resource.router.routes) == 2

resource = ReadOnlyResource(store=owner_store, model=Owner, enable_default_search=False)
resource = ReadOnlyResource(store=owner_store, model=Owner, enable_default_search=False, enable_get_by_key=True)
assert len(resource.router.routes) == 2


Expand All @@ -63,7 +63,7 @@ def test_msonable(owner_store):


def test_get_by_key(owner_store):
endpoint = ReadOnlyResource(owner_store, Owner, disable_validation=True)
endpoint = ReadOnlyResource(owner_store, Owner, disable_validation=True, enable_get_by_key=True)
app = FastAPI()
app.include_router(endpoint.router)

Expand All @@ -76,7 +76,7 @@ def test_get_by_key(owner_store):


def test_key_fields(owner_store):
endpoint = ReadOnlyResource(owner_store, Owner, key_fields=["name"])
endpoint = ReadOnlyResource(owner_store, Owner, key_fields=["name"], enable_get_by_key=True)
app = FastAPI()
app.include_router(endpoint.router)

Expand Down