chore(openapi): test case for model name mapping

[ymc9]

No description provided.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes introduce and update test cases related to the modelNameMapping option for OpenAPI and RESTful API generation. A new test verifies that OpenAPI paths use the mapped model name, and an existing REST test updates the mapping key to match the model's capitalization. No changes were made to exported entities.

Changes

File(s)	Change Summary
packages/plugins/openapi/tests/openapi-restful.test.ts	Renamed a test case, added a new test for modelNameMapping verifying OpenAPI path mapping logic.
packages/server/tests/api/rest.test.ts	Updated test configuration: changed modelNameMapping key from 'user' to 'User'.

Sequence Diagram(s)

sequenceDiagram
    participant Test
    participant OpenAPIPlugin
    participant Model
    participant OpenAPISpec

    Test->>OpenAPIPlugin: Configure with modelNameMapping { User: 'myUser' }
    OpenAPIPlugin->>Model: Load models User, Post (with relation)
    OpenAPIPlugin->>OpenAPISpec: Generate OpenAPI spec with prefix '/api'
    OpenAPISpec-->>Test: Return spec with paths /api/myUser, /api/post
    Test->>OpenAPISpec: Validate paths and structure

Loading

Possibly related PRs

• zenstackhq/zenstack#2190: Adds REST API tests for mapped model names, focusing on verifying modelNameMapping behavior in REST endpoints, similar to the OpenAPI mapping tests introduced here.

---

📜 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 4d75919 and 48c864d.

📒 Files selected for processing (2)

• packages/plugins/openapi/tests/openapi-restful.test.ts (2 hunks)
• packages/server/tests/api/rest.test.ts (1 hunks)

🧰 Additional context used

🧠 Learnings (3)

📓 Common learnings

Learnt from: ymc9
PR: zenstackhq/zenstack#2187
File: packages/server/src/api/rest/index.ts:287-289
Timestamp: 2025-07-16T03:09:04.699Z
Learning: In REST API URL pattern matching with model name mapping, only the `type` parameter (representing model names) should be mapped using `modelNameMapping`. The `relationship` parameter represents field names on models and should not be mapped, as field names are distinct from model names in the API structure.

packages/server/tests/api/rest.test.ts (1)

<retrieved_learning>
Learnt from: ymc9
PR: #2187
File: packages/server/src/api/rest/index.ts:287-289
Timestamp: 2025-07-16T03:09:04.699Z
Learning: In REST API URL pattern matching with model name mapping, only the type parameter (representing model names) should be mapped using modelNameMapping. The relationship parameter represents field names on models and should not be mapped, as field names are distinct from model names in the API structure.
</retrieved_learning>

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

Learnt from: ymc9
PR: zenstackhq/zenstack#2187
File: packages/server/src/api/rest/index.ts:287-289
Timestamp: 2025-07-16T03:09:04.699Z
Learning: In REST API URL pattern matching with model name mapping, only the `type` parameter (representing model names) should be mapped using `modelNameMapping`. The `relationship` parameter represents field names on models and should not be mapped, as field names are distinct from model names in the API structure.

🔇 Additional comments (3)

packages/server/tests/api/rest.test.ts (1)

3041-3041: LGTM! Correct model name mapping alignment.

The change from 'user' to 'User' properly aligns the mapping key with the actual model name as defined in the schema (model User). This ensures consistent mapping behavior where the key matches the exact model name casing.

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

132-132: LGTM: Improved test naming for clarity.

The rename from 'options' to 'common options' makes the test purpose more explicit and distinguishes it from other option-related tests in the file.

---

400-431: LGTM: Well-structured test for model name mapping functionality.

The test correctly validates the modelNameMapping option by:

• Using proper model name capitalization (User: 'myUser') which aligns with the learning from PR feat: add ability to map model names in the URLS/JSON response #2187
• Asserting that mapped paths exist (/api/myUser)
• Confirming original paths are absent (/api/user)
• Verifying unmapped models remain unchanged (/api/post)

The test structure follows established patterns and provides comprehensive coverage for the model name mapping feature.

✨ 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

• 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 explain this code block.
  • @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 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.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

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

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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in 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.