Flow-Launcher / Flow-Launcher/docs
JSON-RPC API: Understanding V1 vs V2, calling Flow APIs from plugins
- Dominant language
- Svelte
- Stars
- 22
- Forks
- 22
- PR merge metrics
- No merged PRs in 30d
Description
### Checks
- [X] I have checked that this issue has not already been reported.
- [X] I am using the latest version of Flow Launcher.
### Problem Description
The docs for JSON-RPC appear inaccurate or misleading in three ways: https://www.flowlauncher.com/docs/#/json-rpc
1. The dataflow `-->` and `<--` is backwards. "Query" is sent from flow to the plugin. Title/Subtitle/IconPath is sent from the plugin to Flow.
2. The example response from Plugin to Flow is incorrect. Should be:
```diff
-<-- {"Title": "title", "SubTitle": "sub title", "IconPath": "favicon.ico"}
+--> {"result": [{"Title": "title", "SubTitle": "sub title", "IcoPath": "favicon.ico"}]}
```
3. The API List is misleading because it is impossible for RPC Plugins to call many (all?) of those methods. For example, how is an RPC plugin supposed to call `ChangeQuery` or `ShowMsg`?
### To Reproduce
_No response_
### Screenshots
_No response_
### Flow Launcher Version
1.19.2
### Windows Build Number
22631.4169
### Error Log
_No response_
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.