docs: release 2.17.0 #475
docs: release 2.17.0 #475
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThe documentation was updated to introduce and explain a new Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant API_Handler
participant Resource
User->>API_Handler: Request to /users (custom mapped path)
API_Handler->>Resource: Map 'User' model to 'users' endpoint
Resource-->>API_Handler: Processed response
API_Handler-->>User: Return response
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/reference/server-adapters/api-handlers/rest.mdx (2)
88-89: Grammar nit: “A” instead of “An”-Optional. An `Record<string, string>` value that provides a mapping +Optional. A `Record<string, string>` value that provides a mapping
100-101: Minor wording fix for clarity-If a mapping is provided, only the mapped url path is valid, and accessing to unmapped path will be denied. +If a mapping is provided, only the mapped URL paths are valid, and access to unmapped paths will be denied.docs/reference/plugins/openapi.mdx (1)
70-83: Minor copy-editing for flowConsider tightening the prose a bit for consistency with the REST handler docs. Example diff:
-This is useful for example when you want to use plural names in URL endpoints. It's only effective for the `rest` flavor. The mapping can be partial. You only need to specify the model names that you want to override. +Useful when you prefer plural resource names in REST endpoints. This option is effective only for the `rest` flavor. The mapping can be partial—specify only the models you want to override.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
docs/reference/plugins/openapi.mdx(2 hunks)docs/reference/server-adapters/api-handlers/rest.mdx(1 hunks)docs/the-complete-guide/part1/5-data-validation.md(1 hunks)versioned_docs/version-1.x/the-complete-guide/part1/5-data-validation.md(1 hunks)
🔇 Additional comments (4)
docs/the-complete-guide/part1/5-data-validation.md (1)
83-86: Indentation tweak looks goodThe extra indentation before
...andslugnow aligns the code block with other examples, preventing potential rendering issues.versioned_docs/version-1.x/the-complete-guide/part1/5-data-validation.md (1)
83-85: Consistent formatting achievedSame indentation correction as the main docs—keeps versioned docs visually in-sync.
docs/reference/server-adapters/api-handlers/rest.mdx (1)
87-98: Nice addition ofmodelNameMappingThis new option is clearly explained and the snippet is actionable—👍.
docs/reference/plugins/openapi.mdx (1)
30-31: Table row correctly inserted
modelNameMappingoption documented in the options table—good catch for parity with REST handler docs.
Summary by CodeRabbit