Pubsub multibase encoding #1065
Conversation
Documenting and clarifying the requirement of multibase encoding when publishing data to a pubsub topic.
|
LGTM, I personally really like that you linked to a tool to assist devs in converting their topic string to Base64URL (really handy especially if someone is coming to the docs after wondering why their Tagging @Annamarie2019 hoping this more complete PR will help alleviate some confusion ❤️. |
There was a problem hiding this comment.
This is a good improvement ❤️ , but this markdown file is generated by this github action workflow, so these changes will get overridden when a new release of go-ipfs ships :(
At very minimum, you also need to update https://github.com/ipfs/ipfs-docs/tree/main/tools/http-api-docs generator and special-case this specific endpoint to include this additional text.
FYSA I filled ipfs/go-ipfs-cmds#224 to add a programatic way to indicate which string fields are expected to be multibase – if someone is able to implement that, then generating docs should be way easier, but it is also fine to special-case in tools/http-api-docs for now, if you find it easier.
|
@lidel thank you so much putting us on the correct path here (even with options)! |
|
Closed PR as per Lidel's message. |
Documenting and clarifying the requirement of multibase encoding when publishing data to a pubsub topic.