Skip to content

Auto-generated JSON-RPC specs have vague parameter docs #13154

@masih

Description

@masih

The JSON-RPC specs are full of vague, auto-generated parameter descriptions that tell you nothing about what the parameters actually do. Example:

"Height": {
"title": "number",
"type": "number"

"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

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    📌 Triage

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions