Skip to content

docs(JSON-RPC): connection example calls a non-existent method - #3856

Open
mcfnord wants to merge 2 commits into
jamulussoftware:mainfrom
mcfnord:docs-jsonrpc-connect-method
Open

docs(JSON-RPC): connection example calls a non-existent method#3856
mcfnord wants to merge 2 commits into
jamulussoftware:mainfrom
mcfnord:docs-jsonrpc-connect-method

Conversation

@mcfnord

@mcfnord mcfnord commented Aug 2, 2026

Copy link
Copy Markdown
Contributor

MY LLM WROTE:

The "Connect to a JSON-RPC server" jayson snippet calls jamulusserver/getServerInfo, which is not a method the server implements — a copy-paste of it returns -32601 Method not found. git log -S getServerInfo shows it entered the doc in #3101 and never existed in src/.

It's also the connection example, so it should show the one call every connection must make first: jamulus/apiAuth. Every other method returns 401 Unauthenticated: Please authenticate using jamulus/apiAuth first until that runs (measured against a --jsonrpcport server on main: getVersion, getMode, and getServerProfile all 401 pre-auth; getServerInfo is -32601 even after auth).

Changing the request to apiAuth fixes both: it's a real method and it's the correct first step. Left as a single request so it doesn't depend on whether jayson reuses the socket across calls (auth is per-connection).

The "Connect to a JSON-RPC server" snippet called
`jamulusserver/getServerInfo`, which the server does not implement
(returns -32601 Method not found). It also skipped authentication,
which every method requires. Use `jamulus/apiAuth` instead: it is a
real method and the mandatory first call on any connection.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@dingodoppelt dingodoppelt added the AI AI generated or potentially AI generated label Aug 3, 2026
@pljones

pljones commented Aug 3, 2026

Copy link
Copy Markdown
Collaborator

See the first ten lines of the file.

JSON-RPC.md is generated by tools/generate_json_rpc_docs.py (see the
file header); editing only the output would be undone on the next
regeneration. Running the generator now reproduces the committed
JSON-RPC.md exactly.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@ann0see

ann0see commented Aug 9, 2026

Copy link
Copy Markdown
Member

What's the consensus here? Close or merge?

@pljones

pljones commented Aug 9, 2026

Copy link
Copy Markdown
Collaborator

Might as well merge.

@pljones pljones added this to Tracking Aug 9, 2026
@github-project-automation github-project-automation Bot moved this to Triage in Tracking Aug 9, 2026
@pljones pljones added this to the Release 4.0.0 milestone Aug 9, 2026
@pljones pljones added the JSON-RPC Related to the JSON-RPC API label Aug 9, 2026
@pljones pljones moved this from Triage to In Progress in Tracking Aug 9, 2026
@pljones pljones added the refactoring Non-behavioural changes, Code cleanup label Aug 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AI AI generated or potentially AI generated JSON-RPC Related to the JSON-RPC API refactoring Non-behavioural changes, Code cleanup

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

4 participants