Skip to content

Commit 7c0737f

Browse files
committed
docs: remove mention of TypeAdapter in vendored-schema-1-implementation.md
Pydantic models can generate their own JSONSchema, and we do generate the JSONSchema directly from the models. TypeAdapter in Pydantic has other uses, but we are not using it here.
1 parent b6f4ea9 commit 7c0737f

File tree

1 file changed

+0
-3
lines changed

1 file changed

+0
-3
lines changed

doc/design/vendored-schema-1-implementation.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ The implemented solution addresses these issues by:
1818

1919
1. Creating an API endpoint to dynamically generate JSONSchema from the Pydantic models at runtime
2020
2. Updating the info endpoint to point to our local schema endpoint instead of GitHub
21-
3. Implementing proper serialization using Pydantic's TypeAdapter to generate the JSONSchema
2221

2322
### New Endpoints
2423

@@ -27,8 +26,6 @@ We've added the following API endpoints:
2726
- `/api/schemas/available/` - Returns the list of available schema models that can be used as a query parameter value for the `/api/schemas/` endpoint
2827
- `/api/schemas/` - Returns the JSONSchema for a queried model specified with the `model` query parameter (e.g., `?model=Dandiset`)
2928

30-
These endpoints use Pydantic's TypeAdapter to generate the JSONSchema directly from the models, ensuring that any runtime vendorization or customization is reflected in the schema.
31-
3229
### Updated Info Endpoint
3330

3431
The `/api/info/` endpoint has been updated to point to our local schema endpoint instead of the GitHub URL. This ensures that frontend clients like the web UI use the schema that matches the running backend exactly, including any vendorization.

0 commit comments

Comments
 (0)