Create IPIP: UnixFS and Gateway support for explicit MIME/Content-Type

未关闭
#364 2 条评论 2 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
25/100
Issue 类型
功能
描述清晰度
需要澄清
活跃度
冷清

调研方向

从 #331 中跟踪的 UnixFS 规范工作开始,然后审查所引用的 gateway 规范以及位于 core/corehttp/gateway_handler_unixfs_file.go 的 Kubo gateway 处理程序。当某个 IPIP 定义了规范的 MIME 存储和 gateway 行为,并且有一个涵盖 ipfs add 和 gateway 响应的 Kubo 参考实现时,这项工作就完成了。

由索引模型根据 Issue 内容生成。

描述

need/community-input need/triage P2

This is a placeholder issue for creating IPIP to add support for storing explicit MIME/Content-Type in UnixFS DAG itself, like we already do for opt-in mode and mtime, and acting on its presence on Gateways.

There is alrernative approach to allow stating explicit content-type header via _headers file (similar to recently shipped _redirects) – some notes in https://github.com/ipfs/specs/issues/257

Context

UnixFSv2 never happened, but ability to explicitly specify Content-Type was one of my asks: https://github.com/ipld/legacy-unixfs-v2/issues/11

Years later, we still guess Content-Type on gateways.
While it is fine for most of the time, but we should provide users with ability to explicitly set media type at the time of data onboarding.

Since 2018 we made some related development: we've added opt-in support for mode and mtime attributes. ~2020 (https://github.com/ipfs/specs/issues/217#issuecomment-582369839). Support for mode and mtime was implemented in JS-IPFS a while ago, Kubo still has PR open (https://github.com/ipfs/go-unixfs/pull/117).

Initial idea (details to be fleshed out in IPIP) is to introduce optional mtype similar way.
This is alternative to introducing _headers file mentioned in https://github.com/ipfs/specs/issues/257.

Ref.

TODO

  • wait until UnixFS specs land (#331)
  • create IPIP against UnixFS specs that
    • defines canonical way of storing explicit MIME (content/media type) in UnixFS root dag-pb blocks.
    • modifies Gateway spec to disable mime-sniffing and use sanitized (ASCII-only) value from dag-pb in Content-Type header
  • Create reference implementation in Kubo
    • adds optional --content-type to ipfs add
    • skip sniffing and set Content-Type header on gateway, if present
主要语言
HTML
星标
1.2k
派生
250
PR 合并指标
30 天内没有已合并 PR

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

ipfs/specs 的其他 Issue

查看 ipfs/specs 的全部 Issue

相似的 Issue

更多 Backend & API Design Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。