feat(cmds): document deprecated RPC API commands #8802
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added programmatic state annotation introduced in ipfs/go-ipfs-cmds#225 for already deprecated / experimental commands.
lidel
added a commit
to ipfs/ipfs-docs
that referenced
this pull request
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.
lidel
changed the title
schomatis
reviewed
Mar 18, 2022
schomatis
reviewed
Mar 18, 2022
schomatis
reviewed
Mar 18, 2022
| Helptext: cmds.HelpText{ | ||
| Tagline: "List directory contents for Unix filesystem objects. Deprecated: Use 'ipfs ls' instead.", | ||
| Tagline: "List directory contents for Unix filesystem objects. Deprecated: Use 'ipfs ls' and 'ipfs files ls' instead.", |
There was a problem hiding this comment.
I just realized we have both an ipfs files and an ipfs file (single) command. the horror
schomatis
reviewed
Mar 18, 2022
schomatis
approved these changes
Mar 18, 2022
6 tasks
lidel
added a commit
to ipfs/ipfs-docs
that referenced
this pull request
Apr 21, 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
added a commit
to ipfs/ipfs-docs
that referenced
this pull request
Apr 21, 2022
Leverages Status field from ipfs/go-ipfs-cmds#225 ipfs/kubo#8802 and uses that information while generating HTTP RPC API reference docs.
11 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
go-ipfs part of ipfs/go-ipfs-cmds#93
This PR adds the programmatic Status annotation introduced in ipfs/go-ipfs-cmds#225
and applies it to for already deprecated / experimental commands.
The main purpose of these annotations is to separate "stable|deprecated|experimental" commands when generating https://docs.ipfs.io/reference/http/api/ (implemented in ipfs/ipfs-docs#1086), but we also show them in
--helptext in CLI:Demo
Deprecated
objectcommandsExperimental
name pubsubcommands