Repository navigation
DOC-7267 Add ioredis and Ruby to the API Methods tab dropdown - #4498
Merged
Merged
Conversation
The ioredis entries rebuilt in #4496 were never shown: the API Methods tab builds its dropdown from a fixed client order in api-methods-tab.html, and that list named every client with a mappingClientId except ioredis (RedisVL and Ruby are also absent and are left alone here). ioredis now sits after Node.js in both the dropdown order and the localStorage tab-sync order. It also gets genericCall="call", which ioredis defines in RedisCommander.d.ts, so a command listed generic_only in the status file would say how to send it. Coverage is thin: 159 of 527 commands have an ioredis list, 62 are empty and 306 have no ioredis key, against about 470 for redis-py, Jedis and go-redis. Those commands show the default "No method signature available for this client." No ioredis status entries were added, because most of the gap is typed methods that were never mapped (EVAL, HGET), not commands ioredis cannot call. Learned: a client with a mappingClientId in config.toml still does not appear in the tab unless it is in both clientOrder lists in api-methods-tab.html Directive: add a client to the tab in both $clientOrder and $jsClientOrder, and give it a genericCall Gaps: 306 commands have no ioredis entry, so the new option shows the default message for most of the command set Gaps: built with content/develop/clients ignored, checked SET, EVAL and ACL in the output Ticket: DOC-7267 Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Contributor
Contributor
🧠 Redis MemoryFound 7 related items from repository history (2 new this commit):
Memory updated at 7232633 |
dwdougherty
approved these changes
Nov 6, 2026
Ruby has a mappingClientId (redis_rb) in config.toml and 217 of 527 commands have a redis_rb list, but the tab's fixed client order omitted it, so that data was never shown. Ruby now sits after PHP in both the dropdown order and the localStorage tab-sync order, and gets genericCall="call", which redis-rb v6.0.0 documents as the public way to send any command (Redis::Commands#call, which delegates to send_command). The other 310 commands have no redis_rb key and show the default message. RedisVL stays out of the dropdown on purpose, because it is handled differently from the other clients. Directive: do not add RedisVL to the API Methods tab client order, the docs team decided it is handled differently Gaps: built with content/develop/clients ignored, checked SET, EVAL and ACL in the output Ticket: DOC-7267 Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
andy-stark-redis
changed the title
Contributor
Author
|
Thanks @dwdougherty ! |
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.
Summary
Adds ioredis and Ruby to the API Methods tab dropdown. The ioredis question was raised in review on #4496. The data for both clients was in
data/command-api-mapping.jsonbut never rendered.config.tomlalready gave both clients amappingClientId, but the dropdown is built from a fixed list inapi-methods-tab.html, and neither was in it."ioredis"after"Node.js"and"Ruby"after"PHP"in$clientOrderand$jsClientOrder.genericCall="call"for both inconfig.toml. ioredis declarescall(command, args)inRedisCommander.d.ts(5.11.1). redis-rb v6.0.0 documentsRedis::Commands#call.Review notes
generic_onlywould be wrong. Filling the gap is separate work under DOC-7267.content/develop/clientsignored (the full site only builds in CI). On SET, EVAL and ACL, the dropdown lists "ioredis" after "Node.js (node-redis)" and "Ruby (redis-rb)" after "PHP (Predis)". SET shows signatures for both; the other two show the default message.🤖 Generated with Claude Code
Note
Low Risk
Docs-only Hugo config and partial list order; no auth, data, or runtime behavior beyond the command-reference UI.
Overview
Adds ioredis and Ruby to the API Methods tab so they appear in the client dropdown and participate in signature rendering and localStorage sync with code tabs.
Config: sets
genericCall="call"for bothioredisandRubyinparams.clientsConfig, so when status isgeneric_onlythe fallback message points at the right generic API.Layout: inserts
ioredisafterNode.jsandRubyafterPHPin both$clientOrderand$jsClientOrderinapi-methods-tab.html, matching the existing mapping data. Coverage for many commands may still show the default “no signature” copy where mappings are missing—that is unchanged and expected per the PR notes.Reviewed by Cursor Bugbot for commit 7232633. Bugbot is set up for automated code reviews on this repo. Configure here.