Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: document deprecated RPC API commands #1086

Merged
merged 1 commit into from
Apr 21, 2022

Conversation

lidel
Copy link
Member

@lidel lidel commented Mar 18, 2022

Leverages Status field from ipfs/go-ipfs-cmds#225 + ipfs/kubo#8802 and uses that information while generating HTTP RPC API reference docs.

  • "Experimental" and "Deprecated" commands are listed in separate sections after regular ones
  • Each command has additional warning box informing about deprecated/experimental state, in case someone opens its docs via direct link

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:

deprecated-2022-03-18_21-54

@lidel lidel changed the title feat: rpc-api deprecated|experimental|.. states feat: document deprecated RPC API commands Mar 18, 2022
@lidel lidel added this to the go-ipfs 0.13 milestone Mar 18, 2022
@lidel lidel self-assigned this Mar 18, 2022
@lidel
Copy link
Member Author

lidel commented Mar 22, 2022

Leverages Status field from
ipfs/go-ipfs-cmds#225
ipfs/kubo#8802
and uses that information while generating HTTP RPC API reference docs.
@lidel lidel force-pushed the docs/rpc-api-docs-cmd-maturity-status branch from 2ad89d5 to 5bff0c0 Compare April 21, 2022 20:57
@filecorgi
Copy link
Contributor

  • Image optimization came back clean!
  • Vuepress build was successful!

@lidel
Copy link
Member Author

lidel commented Apr 21, 2022

I rebased this to build docs for already released go-ipfs 0.12.2, this way we can merge it without waiting for 0.13.

@lidel lidel merged commit b7aef5c into main Apr 21, 2022
@lidel lidel deleted the docs/rpc-api-docs-cmd-maturity-status branch April 21, 2022 21:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants