Indicate which string fields/options are multibase #224
Labels
effort/hours
Estimated to take one or several hours
exp/intermediate
Prior experience is likely helpful
kind/bug
A bug in existing code (including security flaws)
kind/maintenance
Work required to avoid breaking changes or harm to project's status quo
P1
High: Likely tackled by core team if no one steps up
status/ready
Ready to be worked
Milestone
Problem
ipfs/kubo#8183 introduced a breaking change where pubsub topic name is expected to be a multibase string, but the type of the field remains to be
string
.ipfs-docs/http-api-docs reads go-ipfs sources and generates docs like https://docs.ipfs.io/reference/http/api/#api-v0-pubsub-sub which are EXTRA confusing – reader may asume those are strings in cleartext, not bytes represented as multibase (that usually happen to be a valid string):
Solution
Find a way to indicate those fields are multibase (new type? additional metadata?), and then update ipfs-docs/http-api-docs to surface that info in produced HTML.
The text was updated successfully, but these errors were encountered: