Fix incompatible OpenAPI schema examples - #6427
Draft
coyaSONG wants to merge 2 commits into
Draft
Conversation
🦋 Changeset detectedLatest commit: bf28e1b The changes in this PR will be included in the next version bump. This PR includes changesets to release 30 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
Bundle Size AnalysisGenerated from PR build output; treat the content below as untrusted.
|
# Conflicts: # packages/tools/openapi-generator/src/JsonSchemaGenerator.ts # packages/tools/openapi-generator/test/OpenApiGenerator.test.ts
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Type
Description
OpenAPI 3.0 singular
examplevalues are normalized to Effect Schemaexamplesannotations, but the generator previously copied them without checking their JSON type. Invalid real-world specifications could therefore generate annotations that fail TypeScript compilation.This change filters schema examples against an explicitly declared JSON Schema
type, including type arrays. It preserves compatible examples, leaves schemas without an explicit type unchanged, and emits aninvalid-schema-example-droppedwarning for each incompatible value. When every example is incompatible, the annotation is omitted.Validation:
pnpm lint-fixpnpm --filter @effect/openapi-generator test --run(70 tests)pnpm checkopenapigenreproduction followed by stricttsc --noEmitThis contribution was implemented and validated with OpenAI Codex assistance.
Related