ipfs / ipfs/specs

Sunset x-ipfs-path header and unsupported characters

Open
#547 6 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
1.2k
Forks
247
Avg merge
5d 21h
Merged PRs (30d)
4

Description

HTTP header values can only include characters from a limited set, notably not the full unicode smorgasbord.

The HTTP gateway spec doesn't say what to do when the `x-ipfs-path` header would end up containing these characters.

Should they be percent-escaped? Or should the header be omitted entirely?

Contributor guide

No contributing guide indexed for this repository

Research direction

Read the HTTP gateway specification and the existing definition of the x-ipfs-path header first. Resolve the behavior for unsupported Unicode characters, then document the chosen rule in the relevant specification section and ensure the wording covers both percent-escaping and omission cases.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.