feat: Add search_aliases field to node schema#12010
Conversation
Adds `search_aliases` field to improve node discoverability. Users can define alternative search terms for nodes (e.g., "text concat" → StringConcatenate).
Changes:
- Add `search_aliases: list[str]` to V3 Schema
- Add `SEARCH_ALIASES` support for V1 nodes
- Include field in `/object_info` response
- Add aliases to high-priority core nodes
V1 usage:
```python
class MyNode:
SEARCH_ALIASES = ["alt name", "synonym"]
```
V3 usage:
```python
io.Schema(
node_id="MyNode",
search_aliases=["alt name", "synonym"],
...
)
```
## Related PRs
- Frontend: Comfy-Org/ComfyUI_frontend#XXXX (draft - merge after this)
- Docs: Comfy-Org/docs#XXXX (draft - merge after stable)
|
Cinema. I'll do a lil cheeky test locally and then merge. |
|
V1 json looks good. For V3, you'll need to modify NodeInfoV1 dataclass to have a There technically is a NodeInfoV3 class and corresponding get_v3_info function on Schema, but that was made back when we had the assumption we would at some point change how the frontend consumes the V3 schema. I think we are at the point where we will simply keep using the V1 formatting so implementing the change there is not necessary. I will likely do a small PR later to just eradicate all references to that code path. |
christian-byrne
left a comment
There was a problem hiding this comment.
Fixed in dcde864. Added search_aliases field to NodeInfoV1 dataclass and propagated it through Schema.get_v1_info.
Kosinkadink
left a comment
There was a problem hiding this comment.
Alrighty, json is as expected now for V3. Looks good to me.
Adds `search_aliases` to Fuse.js search keys, enabling users to find nodes by alternative names. https://github.com/user-attachments/assets/6bde3e5d-29c7-4cb0-b102-e600a92c7019 ## Changes - Add `search_aliases` to Fuse.js keys in `nodeSearchService.ts` - Add type definition for `search_aliases` field in `nodeDefSchema.ts` **Depends on:** Comfy-Org/ComfyUI#12010 ## Related PRs - **Backend:** Comfy-Org/ComfyUI#12010, Comfy-Org/ComfyUI#12035 - **Adding aliases**: - Comfy-Org/ComfyUI#12016 - Comfy-Org/ComfyUI#12017 - Comfy-Org/ComfyUI#12018 - Comfy-Org/ComfyUI#12019 - **Docs:** Comfy-Org/docs#729 ┆Issue is synchronized with this [Notion page](https://www.notion.so/PR-8223-feat-Add-search_aliases-to-node-search-2ef6d73d365081d89bcccffb33659a88) by [Unito](https://www.unito.io) Co-authored-by: Amp <amp@ampcode.com>
Adds `search_aliases` to Fuse.js search keys, enabling users to find nodes by alternative names. https://github.com/user-attachments/assets/6bde3e5d-29c7-4cb0-b102-e600a92c7019 ## Changes - Add `search_aliases` to Fuse.js keys in `nodeSearchService.ts` - Add type definition for `search_aliases` field in `nodeDefSchema.ts` **Depends on:** Comfy-Org/ComfyUI#12010 ## Related PRs - **Backend:** Comfy-Org/ComfyUI#12010, Comfy-Org/ComfyUI#12035 - **Adding aliases**: - Comfy-Org/ComfyUI#12016 - Comfy-Org/ComfyUI#12017 - Comfy-Org/ComfyUI#12018 - Comfy-Org/ComfyUI#12019 - **Docs:** Comfy-Org/docs#729 ┆Issue is synchronized with this [Notion page](https://www.notion.so/PR-8223-feat-Add-search_aliases-to-node-search-2ef6d73d365081d89bcccffb33659a88) by [Unito](https://www.unito.io) Co-authored-by: Amp <amp@ampcode.com>
Adds
search_aliasesfield to improve node discoverability. Users can define alternative search terms for nodes (e.g., "text concat" → StringConcatenate).Changes
search_aliases: list[str]to V3 Schema incomfy_api/latest/_io.pySEARCH_ALIASESclass attribute support for V1 nodes/object_inforesponse viaserver.pyV1 usage
V3 usage
Related PRs
Nodes with aliases added