update openapi docs#2072
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Greptile SummaryThis PR updates the ENSApi OpenAPI documentation by hiding deprecated/legacy endpoints, reorganizing tag groups, and improving descriptions to better reflect the current API surface.
Confidence Score: 5/5Safe to merge — all changes are OpenAPI metadata and description text with no runtime logic touched. Every changed line is either a string description, a tag name, or an entry in the list of endpoints to suppress from the generated spec. The static JSON file is consistent with the source changes. No business logic, request handling, or data paths are modified. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
subgraph After["After (this PR)"]
T1["Resolution tag"]
T2["Meta tag"]
T1 --> E1["/api/ensip10-resolve"]
T1 --> E2["/api/...other resolution routes"]
T2 --> E3["/api/indexing-status"]
T2 --> E4["/api/realtime"]
T2 --> E5["/health (was: Probes)"]
T2 --> E6["/ready (was: Probes)"]
HIDDEN["Hidden from docs\n(HIDE_OPENAPI_ENDPOINTS)"]
HIDDEN -.-> H1["/api/name-tokens"]
HIDDEN -.-> H2["/api/registrar-actions"]
HIDDEN -.-> H3["/v1/ensanalytics/..."]
HIDDEN -.-> H4["/amirealtime"]
end
subgraph Before["Before"]
OT1["Resolution tag"]
OT2["Meta tag"]
OT3["Explore tag"]
OT4["ENSAwards tag"]
OT5["Probes tag (implicit)"]
OT3 --> OE1["/api/name-tokens"]
OT3 --> OE2["/api/registrar-actions"]
OT4 --> OE3["/v1/ensanalytics/..."]
OT5 --> OE4["/health"]
OT5 --> OE5["/ready"]
end
Reviews (4): Last reviewed commit: "Merge branch 'main' into ll/openapi-smal..." | Re-trigger Greptile |
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ 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 (2)
📝 WalkthroughWalkthroughOpenAPI metadata and configuration updated to clarify indexing status semantics, reorganize health/readiness probe endpoints under the Meta tag, hide legacy analytics endpoints from the generated spec, and remove unused Explore and ENSAwards tag definitions. ChangesOpenAPI Documentation Reorganization
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (2 inconclusive)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. 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.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
apps/ensapi/src/handlers/api/explore/name-tokens-api.routes.ts (1)
43-43:⚠️ Potential issue | 🟠 MajorRemove "Explore" tag references from routes or restore tag definition in openapi-meta.ts.
The "Explore" tag is referenced in this route (and others) but is no longer defined in
apps/ensapi/src/openapi-meta.ts. The tag definitions were removed from the OpenAPI metadata (only "Resolution" and "Meta" tags remain), but the routes still reference undefined tags. This will cause OpenAPI spec generation to fail or produce invalid references.Either:
- Restore the tag definitions for "Explore" and "ENSAwards" in
openapi-meta.ts, or- Remove these tag references from:
apps/ensapi/src/handlers/api/explore/name-tokens-api.routes.ts(line 43)apps/ensapi/src/handlers/api/explore/registrar-actions-api.routes.ts(lines 97, 137)apps/ensapi/src/handlers/ensanalytics/ensanalytics-api.routes.ts(lines 58, 87, 117, 145)🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@apps/ensapi/src/handlers/api/explore/name-tokens-api.routes.ts` at line 43, The OpenAPI tag "Explore" referenced by the route metadata (e.g., the tags: ["Explore"] entry in name-tokens-api.routes.ts) is missing from openapi-meta.ts and causes invalid spec generation; fix this by either restoring the missing tag definitions ("Explore" and "ENSAwards") in apps/ensapi/src/openapi-meta.ts with the same shape as the existing "Resolution"/"Meta" tags, or remove the tag references from the affected route metadata (remove "Explore" / "ENSAwards" entries in the tags arrays found in name-tokens-api.routes.ts, registrar-actions-api.routes.ts, and ensanalytics-api.routes.ts as noted in the review) so every route only references tags defined in openapi-meta.ts.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@apps/ensapi/src/handlers/api/explore/name-tokens-api.routes.ts`:
- Line 43: The OpenAPI tag "Explore" referenced by the route metadata (e.g., the
tags: ["Explore"] entry in name-tokens-api.routes.ts) is missing from
openapi-meta.ts and causes invalid spec generation; fix this by either restoring
the missing tag definitions ("Explore" and "ENSAwards") in
apps/ensapi/src/openapi-meta.ts with the same shape as the existing
"Resolution"/"Meta" tags, or remove the tag references from the affected route
metadata (remove "Explore" / "ENSAwards" entries in the tags arrays found in
name-tokens-api.routes.ts, registrar-actions-api.routes.ts, and
ensanalytics-api.routes.ts as noted in the review) so every route only
references tags defined in openapi-meta.ts.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: dd3392ad-374f-4ae8-933c-9cdcf874ca0c
📒 Files selected for processing (7)
apps/ensapi/src/handlers/api/explore/name-tokens-api.routes.tsapps/ensapi/src/handlers/api/meta/realtime-api.routes.tsapps/ensapi/src/handlers/api/meta/status-api.routes.tsapps/ensapi/src/handlers/ensapi-probes/ensapi-probes-api.routes.tsapps/ensapi/src/openapi-document.tsapps/ensapi/src/openapi-meta.tsdocs/ensnode.io/ensapi-openapi.json
lightwalker-eth
left a comment
lightwalker-eth
left a comment
There was a problem hiding this comment.
@sevenzing Looks good, thanks!
2 participants
Small openapi docs update according to slack message https://namehash.slack.com/archives/C086Z6FNBHN/p1778180028015519
Pre-Review Checklist (Blocking)