Merged
Conversation
dosubot
bot
added
the
size:L
📝 WalkthroughWalkthroughReorganized OpenAPI docs: moved Hey API integration into Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request reorganizes the Hey API integration documentation and introduces a new guide for generating oRPC contracts from OpenAPI specifications. The changes include updating the VitePress sidebar configuration and adding detailed documentation for the Hey API oRPC plugin. A review comment identified an incorrect internal link in the new documentation that needs to be updated to match the actual file path.
More templates
@orpc/ai-sdk
@orpc/arktype
@orpc/client
@orpc/contract
@orpc/experimental-durable-iterator
@orpc/hey-api
@orpc/interop
@orpc/json-schema
@orpc/nest
@orpc/openapi
@orpc/openapi-client
@orpc/otel
@orpc/experimental-pino
@orpc/experimental-publisher
@orpc/experimental-publisher-durable-object
@orpc/experimental-ratelimit
@orpc/react
@orpc/react-query
@orpc/experimental-react-swr
@orpc/server
@orpc/shared
@orpc/solid-query
@orpc/standard-server
@orpc/standard-server-aws-lambda
@orpc/standard-server-fastify
@orpc/standard-server-fetch
@orpc/standard-server-node
@orpc/standard-server-peer
@orpc/svelte-query
@orpc/tanstack-query
@orpc/trpc
@orpc/valibot
@orpc/vue-colada
@orpc/vue-query
@orpc/zod
commit: |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation for generating oRPC contracts from an existing OpenAPI spec using Hey API, and reorganizes the Hey API integration docs under the OpenAPI section to align with the new workflow (Fixes #1061).
Changes:
- Add a new “OpenAPI to Contract” guide describing Hey API
orpcplugin configuration and usage. - Add a new OpenAPI-scoped “Hey API Integration” page covering both contract generation and converting an existing Hey API client to an oRPC client.
- Update VitePress sidebar navigation to include the new page and move the Hey API integration link to its new route (removing the old page).
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| apps/content/docs/openapi/openapi-to-contract.md | New guide explaining how to generate an oRPC contract from an OpenAPI spec via Hey API. |
| apps/content/docs/openapi/integrations/hey-api.md | New integration page describing the two Hey API workflows and linking to the new contract-generation doc. |
| apps/content/docs/integrations/hey-api.md | Removes the old Hey API integration page at the previous route. |
| apps/content/.vitepress/config.ts | Updates sidebar entries to add “OpenAPI to Contract” and repoint “Hey API” to the new OpenAPI integrations route. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@apps/content/docs/openapi/integrations/hey-api.md`:
- Line 19: Replace the broken link string
'/docs/contract-first/openapi-to-contract' in the markdown sentence starting "If
you already have an OpenAPI specification..." with the correct path
'/docs/openapi/openapi-to-contract' so the referenced page resolves; update the
link target in apps/content/docs/openapi/integrations/hey-api.md where the
anchor text "OpenAPI to Contract" is used.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: eb2b7d58-71fa-4833-8285-6f82713125ca
📒 Files selected for processing (4)
apps/content/.vitepress/config.tsapps/content/docs/integrations/hey-api.mdapps/content/docs/openapi/integrations/hey-api.mdapps/content/docs/openapi/openapi-to-contract.md
💤 Files with no reviewable changes (1)
- apps/content/docs/integrations/hey-api.md
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@apps/content/docs/openapi/integrations/hey-api.md`:
- Line 29: The text references the wrong function name: update the prose so the
function name matches the code example; replace `toORPCClient` with
`experimental_toORPCClient` (or alternatively update the code example to use
`toORPCClient`) so both the description and example reference the same function
name (check occurrences of toORPCClient and experimental_toORPCClient in this
section and make them consistent).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 53fff578-75f0-4f8c-a06d-c06247a85287
📒 Files selected for processing (1)
apps/content/docs/openapi/integrations/hey-api.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes: #1061
Summary by CodeRabbit