fix: type in SchemaObject can be an array

[not-my-profile]

Fixes #2.

Summary by CodeRabbit

• New Features
  • Expanded schema support to allow defining schemas with multiple possible types simultaneously.

[coderabbitai]

Walkthrough

A new UnionSchema type alias is introduced to support schemas where the type property is an array of types. This type is incorporated into the main SchemaObject union, enabling the schema system to represent and handle union types as specified in OpenAPI 3.1 and related standards.

Changes

Cohort / File(s)	Change Summary
Schema type system extension src/schema.ts	Refactored type-specific schema interfaces into a mapped TypeSpecifics type; added UnionSchema for multi-type arrays; updated SchemaObject to unify single and union types and include references. Removed individual type aliases.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SchemaSystem

    User->>SchemaSystem: Define schema with type: ["string", "null"]
    SchemaSystem->>SchemaSystem: Match schema to UnionSchema type
    SchemaSystem-->>User: Accepts union type schema

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Assessment against linked issues

Objective	Addressed	Explanation
Support type as an array in schema definitions (#2)	✅

Poem

In the warren where schemas grow,
A rabbit hopped, with code in tow.
Arrays of types now leap and bound,
"String" and "null" together found!
With union magic in the air,
Our schemas flex with extra care.
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8b2e279 and c5d9c01.

📒 Files selected for processing (1)

• src/schema.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/schema.ts

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/schema.ts (1)

89-93: Consider the type safety implications of the union property approach.

The current UnionSchema implementation creates a union of all type-specific properties, meaning a schema with type: ["string", "number"] would expose properties from both string AND number types simultaneously. This might lead to confusing IntelliSense suggestions and doesn't accurately represent the JSON Schema semantics where union types validate against ANY of the specified types.

Consider whether this approach aligns with the intended usage patterns or if a more restrictive type definition would be more appropriate.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fed86eb and 5d8d393.

📒 Files selected for processing (1)

• src/schema.ts (1 hunks)

🔇 Additional comments (2)

src/schema.ts (2)

27-83: Excellent refactoring to consolidate type-specific properties!

The new TypeSpecifics mapped type effectively consolidates all type-specific schema properties into a clean, maintainable structure. The approach of separating type-specific properties from the type discriminator enables flexible composition in the updated SchemaObject definition.

---

98-100: SchemaObject update is well-designed — requires manual validation

The new mapped type over TypeSpecifics, unioned with UnionSchema and the legacy reference fallback, cleanly supports both single and array types per OpenAPI 3.1. Automated searches in TS/TSX, JSON, and YAML fixtures did not locate any literal type: "<kind>" usages, so please manually verify that existing single‐type schemas continue to work end-to-end:

• Ensure unit and integration tests covering { type: "string" }, { type: "number" }, etc., still pass.
• Confirm any JSON/YAML example fixtures or runtime‐loaded schemas with type: "<kind>" behave as expected.