Materials-Consortia / Materials-Consortia/optimade-python-tools

Potential optimisations for requests that do not ask for a filter

Open
#2,093 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement suggestions
Dominant language
Python
Stars
91
Forks
54
PR merge metrics
No merged PRs in 30d

Description

e.g., on server startup, take a series of chunked blobs corresponding to the default sort order of the API, then if a user requests with no filter and no page limit, return this static chunked data directly.

cc @JonathanSchmidt1 @eimrek (maybe this is a useful optimisation for e.g., the Li-ion set too)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are named. Start by tracing how the API handles requests without filters or page limits, then identify the default sort order and response serialization path. Done should include a measured optimization for this request pattern without changing the returned data.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend-api-design, performance
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.