ipfs/kubo

Gateway: client opt-in JSON responses for directory listing

Open

#7,552 opened on Jul 19, 2020

View on GitHub
 (7 comments) (2 reactions) (0 assignees)Go (2,725 forks)batch import
P3effort/daysexp/intermediatehelp wantedkind/enhancementkind/featurestatus/readytopic/gateway

Repository metrics

Stars
 (13,906 stars)
PR merge metrics
 (Avg merge 4d 2h) (28 merged PRs in 30d)

Description

Followup to #7431, that was closed but had the valuable feature of accessing json manifest of folder

requests to a "folder", especially the root of a folder published to ipns such as http://bafzbeibxww7y6v5metkgmxeqkvls74uqvptbhommrb5b7xianigcicdvuy.ipns.localhost/ should be served the same response as https://ipfs.io/api/v0/ls?arg=bafzbeibxww7y6v5metkgmxeqkvls74uqvptbhommrb5b7xianigcicdvuy

IF the accept content type header is set to "application/json" that way there is no interference with existing gateway behaviour and with serving the index.html file at the root

Contributor guide

Research direction
Implement opt in JSON response for directory listing when client sends Accept: application/json header. Follow up on the referenced PR #7431 and consider the existing gateway behavior.
Tech stack
go
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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
GoIPFSHTTP
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65