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

Indicate which string fields/options are multibase #224

Open
lidel opened this issue Jan 31, 2022 · 0 comments
Open

Indicate which string fields/options are multibase #224

lidel opened this issue Jan 31, 2022 · 0 comments
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

Comments

@lidel
Copy link
Member

lidel commented Jan 31, 2022

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.

@lidel lidel added kind/bug A bug in existing code (including security flaws) P1 High: Likely tackled by core team if no one steps up kind/maintenance Work required to avoid breaking changes or harm to project's status quo exp/intermediate Prior experience is likely helpful effort/hours Estimated to take one or several hours status/ready Ready to be worked labels Jan 31, 2022
@ipfs ipfs deleted a comment from welcome bot Jan 31, 2022
@BigLep BigLep added this to the Best Effort Track milestone Mar 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
No open projects
Status: No status
Development

No branches or pull requests

2 participants