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

Adds req for base encoding & points out cURL example #1067

Closed
wants to merge 1 commit into from

Conversation

Annamarie2019
Copy link
Contributor

@Annamarie2019 Annamarie2019 commented Mar 9, 2022

For issue #1007 :

To the argument: Adds the requirement for multibase encoding

To the cURL example: Adds a u before the argument and adds a comment that it's satisfying the argument requirement. @TMoMoreau brought this to my attention in PR #1065 , but I think we should summarize his beautifully word-smithed prose, bc we state it in full in the argument description.

@filecorgi
Copy link
Contributor

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

@johnnymatthews
Copy link
Contributor

This is a sensible suggestion! However, we don't actually make changes to this API documentation manually. This section of the docs docs.ipfs.io/reference/http/api is created automatically by the http-api-docs tool we have in this repo: https://github.com/ipfs/ipfs-docs/tree/main/tools/http-api-docs

The tool spins up an IPFS node, and then asks the node what it can do. The response from the node is output as markdown. So to update the content, we have to create a PR against https://github.com/ipfs/go-ipfs. Buuut, I'm not quite sure where to make the PR. We'll have to get @aschmahmann or @hsanjuan to point us in the right direction.

@Annamarie2019
Copy link
Contributor Author

@johnnymatthews @TMoMoreau Note for future reference: When we create the PR, we should keep in mind that both PRs ( #1067 and #1065 ) address the same issue. I suggest how to coordinate them in #1067.

@hsanjuan
Copy link
Contributor

This documentation is generated from https://github.com/ipfs/go-ipfs/blob/master/core/commands/pubsub.go

@johnnymatthews johnnymatthews deleted the pub-u branch March 23, 2022 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants