refactor(prompts): Enforce zod schemas match openapi types (3/3) #6316
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
commit: |
dosubot
bot
added
the
size:L
cephalization
force-pushed
the
cephalization/prompts/reorganize-ts-schemas-2
branch
from
fcb3895 to
508433b
Compare
cephalization
force-pushed
the
cephalization/prompts/reorganize-ts-schemas-3
branch
from
a3ad339 to
3448a08
Compare
mikeldking
reviewed
Feb 10, 2025
| extra_parameters: z.record(z.unknown()).optional(), | ||
| }); | ||
| export const phoenixPromptResponseFormatSchema = | ||
| schemaMatches<PromptResponseFormat>()( |
There was a problem hiding this comment.
might be worth a comment that running this util enforces the openAPI schema
mikeldking
reviewed
Feb 10, 2025
| @@ -1,18 +1,24 @@ | |||
| import z from "zod"; | |||
| import { jsonSchemaZodSchema } from "../../jsonSchema"; | |||
| import { schemaMatches } from "../../../utils/schemaMatches"; | |||
| import { PromptResponseFormat } from "../../../types/prompts"; | |||
There was a problem hiding this comment.
probably need to shuffle around this directory since it's not clear that this type relates to the REST API based types (e.g. openapi)
mikeldking
approved these changes
Feb 10, 2025
dosubot
bot
added
size:XL
cephalization
merged commit 132cc3a
into
cephalization/prompts/reorganize-ts-schemas-2
6 checks passed
cephalization
deleted the
cephalization/prompts/reorganize-ts-schemas-3
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Depends on #6315
This PR introduces a new type utility to enforce that zod schemas for phoenix prompt types will always match the corresponding openapi generated types.
This pull request is 3 / 3 in a series of refactors to make the TS client easier to understand and maintain
Partially resolves #6305