fix(openapi): type "id" field according to ZModel schema type

[ymc9]

fixes #1908

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces modifications to the OpenAPI plugin's REST generator, focusing on improving how ID fields are represented in the generated OpenAPI schema. The changes allow the id field to reflect its actual type from the ZModel schema instead of being hardcoded as a string. This involves updating the generateModelEntity method to dynamically determine the ID field's schema based on its original type and adjusting how required fields are handled.

Changes

File	Change Summary
packages/plugins/openapi/src/rest-generator.ts	- Modified generateModelEntity method to dynamically generate ID field schema - Updated logic for ID field type representation - Adjusted handling of required fields for ID
packages/plugins/openapi/tests/openapi-restful.test.ts	- Added new test case for integer ID field - Updated buildOptions function to support dynamic specification versioning - Added 'int field as id' test to verify integer ID handling

Assessment against linked issues

Objective	Addressed	Explanation
Return IDs as strings in OpenAPI spec [#1908]	❌	The changes do not ensure IDs are always returned as strings, which is a JSON:API requirement

Possibly related PRs

• OpenApi @@id support #1757: Modifies generateModelEntity method for ID field handling
• fix(openapi): bugfix for compound id create and update #1855: Updates ID field logic in create and update operations
• Improve working with entities related to entities that uses compound ids #1801: Exposes compound ID components in read operations
• Mark openapi attributes as required for reads #1772: Adjusts handling of required fields in schema generation

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

📜 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 93246f3 and 020254f.

📒 Files selected for processing (2)

• packages/plugins/openapi/src/rest-generator.ts (1 hunks)
• packages/plugins/openapi/tests/openapi-restful.test.ts (3 hunks)

🔇 Additional comments (6)

packages/plugins/openapi/tests/openapi-restful.test.ts (3)

87-87: Great use of dynamic 'specVersion' in tests.

Making the spec version configurable fosters flexibility and ensures smoother test coverage for multiple OpenAPI specs.

---

327-327: Consistent approach for dynamic specification versions.

Repeating the same pattern used earlier helps maintain consistency in test generation for different spec versions.

---

343-363: Excellent addition of the 'int field as id' test.

Verifying that an integer-typed ID is correctly represented as an integer in the resulting schema ensures better type fidelity. The test coverage for integer-based IDs is now solid.

packages/plugins/openapi/src/rest-generator.ts (3)

909-916: ID Schema now reflects actual type.

Switching from a hardcoded string to dynamic schema extraction for single field IDs better aligns with the underlying model definition. However, note the comment regarding JSON:API’s requirement for string-based IDs—be sure to confirm that this approach is acceptable for your API consumers.

---

921-921: Conditional inclusion of 'id' property looks correct.

Including an ID field only when there’s no default for create operations avoids overwriting auto-generated IDs. This logic should be verified in edge cases (e.g., custom generation strategies).

---

926-926: Consistent 'id' exposure for read/update.

Ensuring the ID property is universally present in read and update schemas preserves a stable contract. This aligns with most REST conventions where the consumer always expects an 'id' field.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• 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 generate unit testing code for this file.
  • @coderabbitai modularize this function.
• 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 generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

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. (Beta)
• @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.