Skip to content

Indicate which string fields/options are multibase #224

Open
@lidel

Description

@lidel

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):

2022-01-31_15-11

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    P1High: Likely tackled by core team if no one steps upeffort/hoursEstimated to take one or several hoursexp/intermediatePrior experience is likely helpfulkind/bugA bug in existing code (including security flaws)kind/maintenanceWork required to avoid breaking changes or harm to project's status quostatus/readyReady to be worked

    Type

    No type

    Projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions