ipfs/kubo

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

Open

#3,737 创建于 2017年3月1日

在 GitHub 查看
 (19 评论) (1 反应) (0 负责人)Go (13,906 star) (2,725 fork)batch import
help wantedkind/bugtopic/apitopic/rpc-api

描述

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

贡献者指南

技术栈
gorest api
领域
backendapi
议题类型
bug
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Basic understanding of GoFamiliarity with HTTP headersAbility to locate relevant API handler files
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
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.
NDJSON API endpoins should use application/x-ndjson Content-Type header · ipfs/kubo#3737 | Good First Issue