ipfs/specs

Manifest files for unixfs loaded via HTTP Gateway

Open

#257 opened on Nov 18, 2021

View on GitHub
 (8 comments) (11 reactions) (1 assignee)HTML (1,108 stars) (256 forks)batch import
dif/experthelp wantedkind/discussionkind/enhancementkind/maintenanceneed/community-input

Description

This is a placeholder issue for creating a spec for "content root's manifest files" which would be part of the data published on IPFS (eg. /ipfs/CID/_something or /ipfs/CID/.well-known/ipfs/foo) that provides hints to HTTP Gateway around things like redirects, content types and custom HTTP headers.

Related reading:

Possible reuse of:

Feel free to discuss/post ideas below, or open PRs with IPIP drafts that could be reviewed independently.

Contributor guide

Tech stack
None
Domain
apidocumentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic understanding of IPFS and HTTP gatewaysFamiliarity with HTTP headersKnowledge of Netlify's headers file syntax
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Review the existing ` redirects` specification at https://specs.ipfs.tech/http gateways/web redirects file/ and the Netlify and Cloudflare documentation for ` headers` files. Examine the comments in issue #257 for any prior discussion or proposals. Draft an IPIP that defines ` headers` file syntax and semantics for IPFS HTTP Gateways, including support for custom headers and content types.