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 (13,906 stars) (2,725 forks)batch import
P3effort/daysexp/intermediatehelp wantedkind/enhancementkind/featurestatus/readytopic/gateway

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

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.
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go programmingHTTP protocol basicsIPFS gateway concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
The issue requests adding JSON responses for directory listing when the HTTP Accept header is 'application/json'. The implementation should modify the gateway handler to check the Accept header and return JSON similar to the /api/v0/ls endpoint. Reference the closed issue #7431 for context. Focus on the gateway code in the 'gateway' directory, specifically the handler for directory listing. Ensure no interference with existing index.html serving.
Gateway: client opt-in JSON responses for directory listing · ipfs/kubo#7552 | Good First Issue