Skip to content

docs(openapi): update example to use OpenApiJsonSchema and Schema#320

Open
amirs18 wants to merge 1 commit into
elysiajs:mainfrom
amirs18:patch-1
Open

docs(openapi): update example to use OpenApiJsonSchema and Schema#320
amirs18 wants to merge 1 commit into
elysiajs:mainfrom
amirs18:patch-1

Conversation

@amirs18

@amirs18 amirs18 commented Jan 19, 2026

Copy link
Copy Markdown

Summary by CodeRabbit

  • Refactor
    • Updated JSON Schema processing to leverage OpenAPI-compatible libraries.
    • Enhanced support for Date and UUID types in schema handling.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai

coderabbitai Bot commented Jan 19, 2026

Copy link
Copy Markdown
Contributor

Walkthrough

Updates JSON Schema vendor support in OpenAPI handling by replacing JSONSchema from the effect package with OpenApiJsonSchema from @effect/platform. Adds model block exposing Date and UUID via Schema.standardSchemaV1 with usage notes.

Changes

Cohort / File(s) Summary
JSON Schema vendor migration
src/openapi.ts
Replaced JSONSchema.make with OpenApiJsonSchema.make for schema generation. Updated imports to use OpenApiJsonSchema from @effect/platform and Schema from effect. Added model block for Date and UUID definitions with standardSchemaV1. Updated warning string to reflect new vendor.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 Effect's schemas hop anew,
From JSONSchema to OpenAPI's view,
Date and UUID now standardized right,
A vendor swap shining bright! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main change: updating the example code in src/openapi.ts to use OpenApiJsonSchema and Schema from effect packages instead of JSONSchema.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant