Params - add style & explode parameter for deepObject/… encoding by commonism · Pull Request #9867 · fastapi/fastapi

commonism · Jul 12, 2023

Hi,

this PR basically picks up the idea by @adriangb using ` … = Query(style="deepObject") for models in query parameters.
While it currently only serves deepObject for query parameters, it could do the job for all Parameters - depending on the encoding styles/explode combinations supported,

https://spec.openapis.org/oas/v3.1.0#style-examples

Questions -

is supporting Parameter encoding (e.g. deepObject for query parameters) actually intended to be supported by fastapi
which style/explode combinations to support (for which parameter types),
- matrix
- label
- form
- simple
- spaceDelimited
- pipeDelimited
- deepObject

This does deepObject.

This is a clone of #9768 which got closed when deleting a branch.

fixes: #3163

beubeu13220 · Aug 2, 2023

It would be very helpful :)

JoshYuJump · Sep 5, 2023

@commonism
I am wondering whether other style is compatible when I using Query(style="deepObject") explicitly?

commonism · Sep 5, 2023

The deepObject encoding is not compatible to any other encoding.
… all encodings are not interchangeable/compatible, similar to a type specification for a variable.
You need to serve the encoding required.

HansBambel · Jul 5, 2024

This would indeed be helpful. Thank you for the PR!

commonism · Jul 5, 2024

I rebased the changes.

The failure in the CI is related to the documentation build.


Run python ./scripts/docs.py build-lang en
  python ./scripts/docs.py build-lang en
  shell: /usr/bin/bash -e {0}
  env:
    pythonLocation: /opt/hostedtoolcache/Python/3.11.9/x64
    PKG_CONFIG_PATH: /opt/hostedtoolcache/Python/3.11.9/x64/lib/pkgconfig
    Python_ROOT_DIR: /opt/hostedtoolcache/Python/3.11.9/x64
    Python2_ROOT_DIR: /opt/hostedtoolcache/Python/3.11.9/x64
    Python3_ROOT_DIR: /opt/hostedtoolcache/Python/3.11.9/x64
    LD_LIBRARY_PATH: /opt/hostedtoolcache/Python/3.11.9/x64/lib
Insiders file None
Building docs for: en
INFO    -  [macros] - Macros arguments: {'module_name': 'main', 'modules': [], 'render_by_default': True, 'include_dir': '', 'include_yaml': [{'external_links': '../en/data/external_links.yml'}, {'github_sponsors': '../en/data/github_sponsors.yml'}, {'people': '../en/data/people.yml'}, {'sponsors_badge': '../en/data/sponsors_badge.yml'}, {'sponsors': '../en/data/sponsors.yml'}], 'j2_block_start_string': '', 'j2_block_end_string': '', 'j2_variable_start_string': '', 'j2_variable_end_string': '', 'on_undefined': 'keep', 'on_error_fail': False, 'verbose': False}
INFO    -  [macros] - Loading yaml file: /home/runner/work/fastapi/fastapi/docs/en/../en/data/external_links.yml
INFO    -  [macros] - Loading yaml file: /home/runner/work/fastapi/fastapi/docs/en/../en/data/github_sponsors.yml
INFO    -  [macros] - Loading yaml file: /home/runner/work/fastapi/fastapi/docs/en/../en/data/people.yml
INFO    -  [macros] - Loading yaml file: /home/runner/work/fastapi/fastapi/docs/en/../en/data/sponsors_badge.yml
INFO    -  [macros] - Loading yaml file: /home/runner/work/fastapi/fastapi/docs/en/../en/data/sponsors.yml
INFO    -  [macros] - Extra variables (config file): ['analytics', 'social', 'alternate']
INFO    -  [macros] - Extra filters (module): ['pretty']
INFO    -  Cleaning site directory
INFO    -  Building documentation to directory: /home/runner/work/fastapi/fastapi/site_build/en
INFO    -  DeprecationWarning: Passing multiple extensions as a single list or tuple is deprecated. Please pass them as separate arguments instead.
  File "/opt/hostedtoolcache/Python/3.11.9/x64/lib/python3.11/site-packages/mkdocstrings_handlers/python/handler.py", line 275, in collect
    extensions=load_extensions(extensions),
  File "/opt/hostedtoolcache/Python/3.11.9/x64/lib/python3.11/site-packages/griffe/extensions/base.py", line 481, in load_extensions
    warnings.warn(

ERROR   -  Error reading page 'reference/apirouter.md': list index out of range

Not sure what is causing this.
So far I consider it unrelated to the changes.

eyueldk · May 15, 2025

Unfortunate this hasn't been accepted. It would really simplify accepting type safe complex objects in the route.

commonism · May 15, 2025

Just had a look on re-basing.
Ain't easy this time.

commonism · May 25, 2025

Rebased

github-actions · Dec 12, 2025

This pull request has a merge conflict that needs to be resolved.

codspeed-hq · Feb 6, 2026

Merging this PR will not alter performance

✅ 20 untouched benchmarks

_{Comparing commonism:deepObject (6e55cd5) with master (cf55bad)¹}

No successful run was found on master (cc6ced6) during the generation of this report, so cf55bad was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩

github-actions · Feb 6, 2026

This pull request has a merge conflict that needs to be resolved.

allows deepObject encoded Query parameters

github-actions · Feb 11, 2026

This pull request has a merge conflict that needs to be resolved.

commonism force-pushed the deepObject branch 6 times, most recently from 736dcf5 to 601b40d Compare July 13, 2023 06:20

alejsdev added the p4 label Jan 14, 2024

commonism force-pushed the deepObject branch from 601b40d to b28239f Compare July 5, 2024 11:40

NXXR referenced this pull request in SciCompMod/ESID-Backend Dec 12, 2024

deactivate aggregations due to lack of deepobject support

27710f3

NXXR mentioned this pull request Dec 12, 2024

Dynamic aggregations in Query SciCompMod/ESID-Backend#6

Open

commonism force-pushed the deepObject branch from b28239f to ec5c7f8 Compare May 25, 2025 05:49

This comment was marked as outdated.

Sign in to view

commonism force-pushed the deepObject branch 4 times, most recently from 6dd6305 to 98877ee Compare May 25, 2025 06:11

This comment was marked as outdated.

Sign in to view

commonism force-pushed the deepObject branch from 3b3bef9 to c8b37fb Compare June 5, 2025 07:03

This comment was marked as outdated.

Sign in to view

commonism force-pushed the deepObject branch from c8b37fb to 9c7438e Compare June 20, 2025 07:10

This comment was marked as outdated.

Sign in to view

commonism force-pushed the deepObject branch from 57d7946 to 4d5b706 Compare November 4, 2025 12:25

github-actions bot removed the conflicts Automatically generated when a PR has a merge conflict label Nov 4, 2025

commonism force-pushed the deepObject branch 2 times, most recently from d53f38c to f6261e2 Compare November 4, 2025 12:31

github-actions bot added the conflicts Automatically generated when a PR has a merge conflict label Nov 19, 2025

This comment was marked as resolved.

Sign in to view

commonism force-pushed the deepObject branch 2 times, most recently from f6261e2 to 096938d Compare November 20, 2025 06:36

github-actions bot removed the conflicts Automatically generated when a PR has a merge conflict label Nov 20, 2025

commonism force-pushed the deepObject branch 2 times, most recently from 8a27ae1 to 26c4a99 Compare November 20, 2025 10:05

github-actions bot added the conflicts Automatically generated when a PR has a merge conflict label Dec 4, 2025

This comment was marked as resolved.

Sign in to view

commonism force-pushed the deepObject branch from 26c4a99 to fc509bd Compare December 4, 2025 09:50

github-actions bot removed the conflicts Automatically generated when a PR has a merge conflict label Dec 4, 2025

github-actions bot added the conflicts Automatically generated when a PR has a merge conflict label Dec 12, 2025

commonism force-pushed the deepObject branch from fc509bd to 6cc9fd1 Compare February 6, 2026 06:34

github-actions bot removed the conflicts Automatically generated when a PR has a merge conflict label Feb 6, 2026

commonism force-pushed the deepObject branch 2 times, most recently from d345801 to 8dc3f28 Compare February 6, 2026 07:24

github-actions bot added the conflicts Automatically generated when a PR has a merge conflict label Feb 6, 2026

commonism force-pushed the deepObject branch from 8dc3f28 to 238cbcc Compare February 7, 2026 06:52

Params - add style & explode parameter

6e55cd5

allows deepObject encoded Query parameters

commonism force-pushed the deepObject branch from 238cbcc to 6e55cd5 Compare February 7, 2026 06:58

github-actions bot added conflicts Automatically generated when a PR has a merge conflict and removed conflicts Automatically generated when a PR has a merge conflict labels Feb 7, 2026

Search code, repositories, users, issues, pull requests...

Uh oh!

Conversation

commonism commented Jul 12, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

beubeu13220 commented Aug 2, 2023

Uh oh!

JoshYuJump commented Sep 5, 2023

Uh oh!

commonism commented Sep 5, 2023

Uh oh!

HansBambel commented Jul 5, 2024

Uh oh!

commonism commented Jul 5, 2024

Uh oh!

eyueldk commented May 15, 2025

Uh oh!

commonism commented May 15, 2025

Uh oh!

This comment was marked as outdated.

This comment was marked as outdated.

commonism commented May 25, 2025

Uh oh!

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as resolved.

This comment was marked as resolved.

github-actions bot commented Dec 12, 2025

Uh oh!

codspeed-hq bot commented Feb 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merging this PR will not alter performance

Footnotes

Uh oh!

github-actions bot commented Feb 6, 2026

Uh oh!

github-actions bot commented Feb 11, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

commonism commented Jul 12, 2023 •

edited

Loading

codspeed-hq bot commented Feb 6, 2026 •

edited

Loading