-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Description
The JSON-RPC specs are full of vague, auto-generated parameter descriptions that tell you nothing about what the parameters actually do. Example:
lotus/build/openrpc/gateway.json
Lines 163 to 165 in 54bd2c7
"Height": { | |
"title": "number", | |
"type": "number" |
lotus/build/openrpc/gateway.json
Lines 211 to 214 in 54bd2c7
"Timestamp": { | |
"title": "number", | |
"type": "number" | |
}, |
Why this sucks
Gateway operators trying to implement against the spec have to dig into the Go code to figure out what these parameters actually represent. The whole point of having a spec is to avoid reading implementation code.
Right now the JSON-RPC spec is basically useless for understanding the API - it's just a schema with no meaningful documentation.
What we need
Fix the auto-generation tooling to pull actual parameter names and documentation from the Go source instead of generating generic "number" placeholders.
The spec should be self-documenting, not force everyone to reverse-engineer the Go interfaces.
Metadata
Metadata
Assignees
Labels
Type
Projects
Status