feat: document deprecated RPC API commands #1086
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Leverages Status field from ipfs/go-ipfs-cmds#225 + ipfs/kubo#8802 and uses that information while generating HTTP RPC API reference docs.
Demo
These additional annotations are not present in go-ipfs 0.12, but will be present when 0.13 ships.
For now, I generated
docs/reference/http/api.md
using this PR for easier preview: