docs: fix "Bracket Notation" example

[unnoq]

Summary by CodeRabbit

• Documentation
  • Refined JSON examples for improved clarity and readability. The example now presents numeric values and missing data as strings, and it uses a consistent placeholder for binary data. These updates standardize the documentation's presentation, making it easier for users to understand the example structures.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
orpc	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 20, 2025 4:10am

[coderabbitai]

Walkthrough

The pull request updates the JSON example in the "Complex Example" section of the bracket-notation documentation. In the JSON, numerical and null values in the "ages" array are replaced with string representations and a placeholder for an empty value. Similarly, the placeholder in the "files" array is standardized. No changes were made to any public or exported entities.

Changes

File(s)	Change Summary
apps/.../openapi/bracket-notation.md	Updated the JSON structure in the "Complex Example": the "ages" array now uses string values ("18", "<empty>", "25") instead of numeric/null entries, and the "files" placeholder is changed from "...binary data..." to "<binary data>".

Poem

I'm a happy rabbit with a hoppy beat,
Skipping through docs with updates so neat.
JSON arrays now sing in strings, oh what fun,
With placeholders shining like a bright sun.
Hop along, dear code, your change is complete!
🐇🌟

---

📜 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 8f622a0 and b2fd80d.

📒 Files selected for processing (1)

• apps/content/docs/openapi/bracket-notation.md (1 hunks)

🔇 Additional comments (1)

apps/content/docs/openapi/bracket-notation.md (1)

82-83: Standardized JSON Example for Clarity and Consistency

The updated JSON in the "Complex Example" section now uses string representations for numeric values in the "ages" array and employs <empty> as a placeholder for missing values. Similarly, the "files" array now uses <binary data> instead of the previous placeholder. These changes improve clarity and consistency in the documentation. Please verify that these updated representations align with the expected parsing behavior and documentation standards.

---

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.
  • Generate unit testing code for this file.
  • 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 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.
• @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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

[pkg-pr-new]

Open in Stackblitz

More templates

• @orpc/contract-first-playground
• @orpc/nextjs-playground
• @orpc/nuxt-playground
• @orpc/solid-start-playground
• @orpc/svelte-kit-playground

@orpc/arktype

npm i https://pkg.pr.new/@orpc/arktype@274

@orpc/client

npm i https://pkg.pr.new/@orpc/client@274

@orpc/openapi

npm i https://pkg.pr.new/@orpc/openapi@274

@orpc/contract

npm i https://pkg.pr.new/@orpc/contract@274

@orpc/openapi-client

npm i https://pkg.pr.new/@orpc/openapi-client@274

@orpc/react-query

npm i https://pkg.pr.new/@orpc/react-query@274

@orpc/server

npm i https://pkg.pr.new/@orpc/server@274

@orpc/shared

npm i https://pkg.pr.new/@orpc/shared@274

@orpc/solid-query

npm i https://pkg.pr.new/@orpc/solid-query@274

@orpc/standard-server

npm i https://pkg.pr.new/@orpc/standard-server@274

@orpc/standard-server-fetch

npm i https://pkg.pr.new/@orpc/standard-server-fetch@274

@orpc/standard-server-node

npm i https://pkg.pr.new/@orpc/standard-server-node@274

@orpc/svelte-query

npm i https://pkg.pr.new/@orpc/svelte-query@274

@orpc/valibot

npm i https://pkg.pr.new/@orpc/valibot@274

@orpc/vue-colada

npm i https://pkg.pr.new/@orpc/vue-colada@274

@orpc/vue-query

npm i https://pkg.pr.new/@orpc/vue-query@274

@orpc/zod

npm i https://pkg.pr.new/@orpc/zod@274

commit: b2fd80d