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

Use pydantic model for Query parameters

Open
#2,151 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

dependency_updates enhancement models priority/low server
Dominant language
Python
Stars
91
Forks
54
PR merge metrics
No merged PRs in 30d

Description

It seems the latest (v0.115.0) version of FastAPI now (finally) supports using pydantic models for the query parameters (and more). This should be used in the repository to properly define the query parameters.

See the release notes for more information.

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

Start by locating the repository's query-parameter definitions and review the FastAPI 0.115.0 release notes linked in the issue. Replace the relevant query-parameter definitions with Pydantic models, then verify that the API schema and existing tests still cover the same parameters.

Written by the indexing model from the issue text.

Assessment

Tech stack
fastapi, python
Domain
api, backend
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.