anomaly / anomaly/lab-python-server

Explore the option of sending partial entities as responses

Open
#28 0 comments 0 reactions 1 assignee Claimed by @devraj View on GitHub
Dominant language
Python
Stars
16
Forks
4
PR merge metrics
No merged PRs in 30d

Description

This is something I miss from my `prestans` days, we have a [feature](https://prestans.readthedocs.io/en/latest/validation.html#attribute-filters) we called `attribute_filters` it essentially allowed us toggle the visibility of fields in responses. What this allowed is to use the same model for different use cases e.g:

- List of users in the master view only needs, `id`, `name`, `email`
- Clicking a user then loads the entire user including children model (this is the heavy weight use case)

Pydantic has the idea of [excluding](https://pydantic-docs.helpmanual.io/usage/exporting_models/#advanced-include-and-exclude) keys when it serializes content.

Explore and document:
- if this is possible using the FastAPI + pydantic toolset
- is this an OK thing to do according the OpenAPI specification

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.