Conversation
…ation to reflect changes in public config endpoint
🦋 Changeset detectedLatest commit: d42ad67 The changes in this PR will be included in the next version bump. This PR includes changesets to release 24 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 22 minutes and 31 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughThe pull request removes the deprecated Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~22 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/ensnode.io/src/content/docs/ensrainbow/concepts/versioning.mdx`:
- Around line 12-14: The docs show a semantic version example with a leading "v"
("v0.4.2") which conflicts with the `/v1/config` API that returns
packageJson.version (e.g., "0.1.0"); update the example and any mentions in this
section to drop the "v" prefix so the documented format matches `/v1/config` and
packageJson.version.
In `@docs/ensnode.io/src/content/docs/ensrainbow/usage/api.mdx`:
- Line 16: Update the endpoint summary for `GET /v1/config` to use the exported
SDK interface name `EnsRainbowPublicConfig` (instead of
`ENSRainbowPublicConfig`); locate the line listing the `GET /v1/config` route in
the API table and replace the type reference so casing matches the authoritative
interface `EnsRainbowPublicConfig`.
🪄 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: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 0bed8751-4606-45d1-a788-291403c7c244
📒 Files selected for processing (7)
apps/ensrainbow/src/commands/server-command.test.tsapps/ensrainbow/src/lib/api.tsdocs/ensnode.io/src/content/docs/ensrainbow/concepts/versioning.mdxdocs/ensnode.io/src/content/docs/ensrainbow/contributing/index.mdxdocs/ensnode.io/src/content/docs/ensrainbow/usage/api.mdxpackages/ensrainbow-sdk/src/client.test.tspackages/ensrainbow-sdk/src/client.ts
💤 Files with no reviewable changes (4)
- packages/ensrainbow-sdk/src/client.test.ts
- apps/ensrainbow/src/commands/server-command.test.ts
- apps/ensrainbow/src/lib/api.ts
- packages/ensrainbow-sdk/src/client.ts
There was a problem hiding this comment.
Pull request overview
Removes the deprecated ENSRainbow /v1/version HTTP endpoint and the corresponding deprecated version() method/types from @ensnode/ensrainbow-sdk, updating ENSRainbow docs to use /v1/config as the discovery surface.
Changes:
- Removed
GET /v1/versionroute from the ENSRainbow service and deleted its integration test coverage. - Removed deprecated
EnsRainbowApiClient.version()plusVersion*types and unit tests from@ensnode/ensrainbow-sdk. - Updated ENSRainbow documentation to reference
GET /v1/configand theENSRainbowPublicConfigshape.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| packages/ensrainbow-sdk/src/client.ts | Removes the deprecated version() client method and Version* types. |
| packages/ensrainbow-sdk/src/client.test.ts | Deletes the unit test that exercised client.version(). |
| apps/ensrainbow/src/lib/api.ts | Removes the deprecated /v1/version API route implementation. |
| apps/ensrainbow/src/commands/server-command.test.ts | Removes server tests that validated /v1/version and its CORS preflight. |
| docs/ensnode.io/src/content/docs/ensrainbow/usage/api.mdx | Updates API reference to describe /v1/config instead of /v1/version. |
| docs/ensnode.io/src/content/docs/ensrainbow/contributing/index.mdx | Fixes contribution guide link formatting. |
| docs/ensnode.io/src/content/docs/ensrainbow/concepts/versioning.mdx | Updates version endpoint reference from /v1/version to /v1/config. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…ntation for config endpoint
Greptile SummaryThis PR removes the deprecated
Confidence Score: 4/5Safe to merge after correcting the changeset bump from All code changes are correct and well-scoped — the endpoint, SDK method, types, tests, and docs are consistently updated. The single blocking concern is the semver classification: removing a public method from a published SDK package is a breaking change and must use a .changeset/odd-seahorses-sleep.md — the version bump type needs to change from Important Files Changed
Sequence DiagramsequenceDiagram
participant Client
participant ENSRainbow API
Note over Client,ENSRainbow API: Before this PR
Client->>ENSRainbow API: GET /v1/version (deprecated)
ENSRainbow API-->>Client: { status, versionInfo: { version, dbSchemaVersion, labelSet } }
Note over Client,ENSRainbow API: After this PR
Client->>ENSRainbow API: GET /v1/config
ENSRainbow API-->>Client: { version, labelSet, recordsCount }
Reviews (1): Last reviewed commit: "chore(ensrainbow): remove deprecated ver..." | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| @@ -0,0 +1,6 @@ | |||
| --- | |||
| "@ensnode/ensrainbow-sdk": minor | |||
There was a problem hiding this comment.
minor
Removing the public version() method from @ensnode/ensrainbow-sdk is a breaking API change — any consumer calling client.version() will get a runtime TypeError: client.version is not a function after upgrading. Under semver, this requires a major bump, not minor, regardless of the prior @deprecated annotation.
| "@ensnode/ensrainbow-sdk": minor | |
| "@ensnode/ensrainbow-sdk": major |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 8 out of 8 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Lite PR
Tip: Review docs on the ENSNode PR process
Summary
GET /v1/versionendpoint (deprecated in favor ofGET /v1/config).version()client method and associated types/tests.GET /v1/configinstead ofGET /v1/version.Why
/v1/versionwas already deprecated and duplicated the newer/v1/configdiscovery surface; removing it reduces maintenance and avoids clients relying on a legacy endpoint.Testing
Notes for Reviewer (Optional)
/v1/versionwas limited to ENSRainbow’s own integration test and the deprecated@ensnode/ensrainbow-sdkversion()method; ENSIndexer already usesensRainbowClient.config().Pre-Review Checklist (Blocking)