feat(api): Add Pydantic schemas in OpenAPI annotations #19408
Conversation
webjunkie
changed the title
|
Size Change: 0 B Total Size: 2 MB ℹ️ View Unchanged
|
📸 UI snapshots have been updated1 snapshot changes in total. 0 added, 1 modified, 0 deleted:
Triggered by this commit. |
📸 UI snapshots have been updated1 snapshot changes in total. 0 added, 1 modified, 0 deleted:
Triggered by this commit. |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
|
This PR hasn't seen activity in a week! Should it be merged, closed, or further worked on? If you want to keep it open, post a comment or remove the |
webjunkie
force-pushed
the
feature/openapi-pydantic
branch
from
764a7c6 to
a1ab542
Compare
# Conflicts: # posthog/api/services/query.py
frontend/src/queries/schema.ts
Outdated
| // Dynamically make a union type out of all the "response" fields in QuerySchema | ||
| type ResponseType<T> = T extends { response: infer R } ? R : never | ||
| type AllResponses = ResponseType<QuerySchema> | ||
| type Unionize<T> = Partial<{ | ||
| [P in keyof T]: T[P] | ||
| }> | ||
| export type QueryCombinedResponse = Unionize<AllResponses> |
| # query_json has been parsed by QuerySchemaParser | ||
| # it _should_ be impossible to end up in here with a "bad" query | ||
| query_kind = query_json.get("kind") | ||
| tag_queries(query=query_json) |
There was a problem hiding this comment.
@mariusandra not sure what this does, and I don't have a dict anymore that I can pass to it
There was a problem hiding this comment.
This adds a copy of the input query into ClickHouse's system.query_log table.
There was a problem hiding this comment.
So what can we do? I don't want to serialize again.
There was a problem hiding this comment.
I tag the queries where I still have the dict.
# Conflicts: # frontend/src/queries/schema.ts
Trying again #19408 with fixes
Problem
We don't or can't use our Pydantic models as schemas in our OpenAPI spec.
We also don't use discriminate unions to have the model validation work better.
Changes
isinstancedoesn't work on type aliases that use a union python/mypy#11673request.dataas the Pydantic model, but everything in Django/DRF expectsrequest.datato be a dict, so that's a no-goHow did you test this code?