JSON-RPC API: Understanding V1 vs V2, calling Flow APIs from plugins
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- api, documentation
Research direction
Start with the JSON-RPC documentation page linked in the issue and compare its data-flow diagram and response example with the reported corrections. Then verify which listed methods RPC plugins can call, especially ChangeQuery and ShowMsg. Done means the page accurately explains the request and response directions and presents an API list and plugin-calling guidance that match the implementation.
Written by the indexing model from the issue text.
Description
Checks
-
I have checked that this issue has not already been reported.
-
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
- The dataflow
-->and<--is backwards. "Query" is sent from flow to the plugin. Title/Subtitle/IconPath is sent from the plugin to Flow. - The example response from Plugin to Flow is incorrect. Should be:
-<-- {"Title": "title", "SubTitle": "sub title", "IconPath": "favicon.ico"}
+--> {"result": [{"Title": "title", "SubTitle": "sub title", "IcoPath": "favicon.ico"}]}
- 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
ChangeQueryorShowMsg?
To Reproduce
No response
Screenshots
No response
Flow Launcher Version
1.19.2
Windows Build Number
22631.4169
Error Log
No response
- Dominant language
- Svelte
- Stars
- 23
- Forks
- 23
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Flow-Launcher/docs
-
documentation
Difficulty 3/5 1-2 days Newbie friendliness 25/100
Flow-Launcher/docs#99 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 45/100
Flow-Launcher/docs#79 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
Flow-Launcher/docs#49 · 1 comment ·
-
enhancement
Difficulty 4/5 3-5 days Newbie friendliness 42/100
Flow-Launcher/docs#45 · 1 reaction ·
-
Deploy on Vercel Open
Difficulty 5/5 Over a week Newbie friendliness 25/100
Flow-Launcher/docs#4 · 12 comments ·
All issues in Flow-Launcher/docs
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
syfoud/Simulated_Scepter#172 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
crossplane/crossplane#7859 ·
-
bot:ai-assisted component:compact-js status:untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
midnightntwrk/midnight-sdk#403 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
nightscout/nocturne#1379 ·