[DX Streamline] OpenRPC definitions are inaccurate

[aatifsyed]

Checklist

• [X] This is not a security-related bug/issue. If it is, please follow please follow the security policy.
• [X] I have searched on the issue tracker and the lotus forum, and there is no existing related issue or discussion.
• [X] I am running the Latest release, the most recent RC(release canadiate) for the upcoming release or the dev branch(master), or have an issue updating to any of these.
• [X] I did not make any code changes to lotus.

Lotus component

• [ ] lotus daemon - chain sync
• [ ] lotus fvm/fevm - Lotus FVM and FEVM interactions
• [ ] lotus miner/worker - sealing
• [ ] lotus miner - proving(WindowPoSt/WinningPoSt)
• [X] lotus JSON-RPC API
• [ ] lotus message management (mpool)
• [ ] Other

Lotus Version

1.27.1

Repro Steps

No response

Describe the Bug

https://github.com/filecoin-project/lotus/blob/36d96342c36186ab15417b53511dce94b66ae089/build/openrpc/full.json#L71-L91

The schema for, e.g cid is wrong - it's not

{
  "type": "string"
}

it's

{
  "type": "object",
  "required": ["/"],
  "properties": {
    "/": { "type": "string" }
  }
}

(as expected and emitted by lotus)

Logging Information

N/A

[aatifsyed]

There may be other bugs in the definitions - forest has put effort into emitting correct schemas which may be a useful reference

[rvagg]

Great! Thanks for this one.

What about the use of TipSetKey, they seem to be "type": ["object"] but could be defined as an array of CIDs, does Forest do this differently?

[aatifsyed]

Yep, forest represents them correctly, also respecting the quirk that empty arrays are serialized as null by Lotus

{
  "type": [
    "array",
    "null"
  ],
  "items": {
    "$ref": "#/components/schemas/Cid"
  },
  "components": {
    "schemas": {
      "Cid": {
        "type": "object",
        "required": [
          "/"
        ],
        "properties": {
          "/": {
            "type": "string"
          }
        }
      }
    }
  }
}

[aatifsyed]

• related: #12214