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

Abierto
#364 2 comentarios 2 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Tranquilo

Línea de trabajo

Comienza con el trabajo sobre las especificaciones de UnixFS registrado en #331; después, revisa la especificación de gateway referenciada y el controlador de gateway de Kubo en core/corehttp/gateway_handler_unixfs_file.go. El trabajo estará terminado cuando un IPIP defina el almacenamiento MIME canónico y el comportamiento del gateway, con una implementación de referencia de Kubo que cubra ipfs add y las respuestas del gateway.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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
Lenguaje dominante
HTML
Estrellas
1.2k
Forks
250
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de ipfs/specs

Todos los issues de ipfs/specs

Issues similares

Más issues de Backend & API Design

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.