ipfs/kubo

NDJSON API endpoins should use application/x-ndjson Content-Type header

Open

#3737 opened on Mar 1, 2017

View on GitHub
 (19 comments) (1 reaction) (0 assignees)Go (13,906 stars) (2,725 forks)batch import
help wantedkind/bugtopic/apitopic/rpc-api

Description

Version information:

go-ipfs version: 0.4.5-
Repo version: 5
System version: amd64/darwin
Golang version: go1.7.4

Type: Bug

Priority: P2

Description:

Compare:

curl -D - "http://localhost:5001/api/v0/log/tail"
HTTP/1.1 200 OK
Access-Control-Allow-Headers: X-Stream-Output, X-Chunked-Output, X-Content-Length
Access-Control-Expose-Headers: X-Stream-Output, X-Chunked-Output, X-Content-Length
Content-Type: text/plain
Server: go-ipfs/0.4.5
Trailer: X-Stream-Error
Vary: Origin
X-Stream-Output: 1
Date: Wed, 01 Mar 2017 10:14:45 GMT
Transfer-Encoding: chunked

curl -D - "http://localhost:5001/api/v0/pubsub/sub?arg=<topic>&discover=false"
HTTP/1.1 200 OK
Access-Control-Allow-Headers: X-Stream-Output, X-Chunked-Output, X-Content-Length
Access-Control-Expose-Headers: X-Stream-Output, X-Chunked-Output, X-Content-Length
Content-Type: application/json
Server: go-ipfs/0.4.5
Trailer: X-Stream-Error
Vary: Origin
X-Chunked-Output: 1
Date: Wed, 01 Mar 2017 10:14:53 GMT
Transfer-Encoding: chunked

Not only they are different, they are both wrong as proper content type is application/x-ndjson.

Edited by Kubuxu

Contributor guide

Tech stack
gorest api
Domain
backendapi
Issue type
bug
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.
under 1 hour
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
Basic understanding of GoFamiliarity with HTTP headersAbility to locate relevant API handler files
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue is to change the Content Type header of two IPFS API endpoints (`/api/v0/log/tail` and `/api/v0/pubsub/sub`) from `text/plain` and `application/json` respectively to `application/x ndjson`. The solution involves finding the Go source files that handle these endpoints (likely in the `core/commands` or `api/` directory) and modifying the header set. Specifically, look for where `w.Header().Set("Content Type", ...)` is called in the response handlers for these endpoints. A similar pattern can be found in other endpoints that already use the correct content type. Note: There may be discussion in the comments about whether to use `application/x ndjson` or `application/x ndjson`; check the conversation for consensus.