Purpose

This document provides supplementary information to the F3-aware APIs that are being generated as part of https://github.com/filecoin-project/lotus/issues/12987. Some doc writing and notes are captured here rather than inline in the Lotus repo because of deficiencies in Lotus’ API doc process. We didn’t want Lotus’ deficiencies to obfuscate/prevent us from being able to get feedback from Lotus consumers. Where Lotus is getting in the way, we’ll be scrappy and use

Critical Links

Filecoin V2 APIs

• Tracking issue: https://github.com/filecoin-project/lotus/issues/12987
• Lotus OpenRPC /v2 definition: https://github.com/filecoin-project/lotus/blob/master/build/openrpc/v2/full.json
• Lotus Markdown v2 definition: https://github.com/filecoin-project/lotus/blob/master/documentation/en/api-v2-unstable-methods.md
• godocs:

User Feedback / Meetings

F3 Aware API Feedback Meetings

FAQ

What are the deficiencies in the Lotus API doc process that we encountered in this API design process?

1. docsgen only allows for one example (PR comment). This was problematic for APIs that take a parameter like TipSetSelector which provides a lot of optionality.
2. Markdown documentation which docs.filecoin.io uses has not way to reference rich types like TipSetSelector

Past / Old Documents

(WIP) F3 API exchanges

(WIP) API updates w/ F3