IPIP-288: TAR Gateway Response Format by hacdias · Pull Request #288 · ipfs/specs

hacdias · 2022-06-10T12:27:11Z

lidel

@hacdias looks good!

Got small ask: we are adopting light RFC process (#286), and this is a very nice, small improvement we could use to test the process.

Do you mind copying RFC/0000-template.md from #289 and adding it to this PR?

It can be literally one sentence per each section – we just want to start explaining value to the user when we make changes like this one. Here, the benefit to the user is clear, they can download the entire directory. Alternatives and Security could include concerns around .gz variant, as noted in ipfs/kubo#9034

hacdias · 2022-06-16T11:26:34Z

@lidel done 😄

lidel

Thank you @hacdias!

Will get back to this when I have more time, but quick feedback for now:

TAR will be under similar special-case as CAR (weak Etag, no guarantee of byte-for-byte reproducibility), so need to add it to sections about cache control headers:

rename RFC in markdown and file paths and names to IPIP (#289)
mention TAR next to CAR in Etag (response header)
mention TAR next to CAR in Cache-Control (response header)

RFC/0000-gateway-tar-response-format.md

http-gateways/PATH_GATEWAY.md

hacdias · 2022-06-30T12:18:39Z

@lidel made the updates you asked for. Let me know if there's anything that should be re-written or added.

lidel · 2022-07-11T17:51:16Z

@hacdias mind resolving conflicts / rebasing on top of main? I'll be going over IPIPs next week 🙏

hacdias · 2022-07-15T09:26:59Z

@lidel done!

SgtPooki

minor nits after reading through

IPIP/0000-gateway-tar-response-format.md

http-gateways/PATH_GATEWAY.md

IPIP/0000-gateway-tar-response-format.md

Co-authored-by: Marcin Rataj <lidel@lidel.org>

hacdias · 2022-10-12T11:05:28Z

@lidel added remaining fixtures. Cleaned up the copy.

lidel

We've discussed this during IPFS Implementers Sync today and ratified this.

Keeping this open in case we want to make any last-moment clarifications based on ipfs/kubo#9029 (will merge this spec after we land working code).

See "Security" section of IPIP-288 (ipfs/specs#288)

Implementation of IPIP-288 (ipfs/specs#288) Co-authored-by: Marcin Rataj <lidel@lidel.org>

lidel · 2022-11-09T19:15:18Z

Merging.

If anyone is interested in trying it out, a working Implementation from ipfs/kubo#9029 will ship in Kubo 0.17-rc1.

See "Security" section of IPIP-288 (ipfs/specs#288) This commit was moved from ipfs/go-ipfs-files@e8cf9a3

Implementation of IPIP-288 (ipfs/specs#288) Co-authored-by: Marcin Rataj <lidel@lidel.org> This commit was moved from ipfs/kubo@a210abd

Implementation of IPIP-288 (ipfs/specs#288) Co-authored-by: Marcin Rataj <lidel@lidel.org>

hacdias requested a review from lidel as a code owner June 10, 2022 12:27

hacdias mentioned this pull request Jun 10, 2022

feat(gateway): TAR response format ipfs/kubo#9029

Merged

6 tasks

hacdias changed the title ~~feat: initial HTTP gateway specs~~ Add TAR Gateway Format Jun 10, 2022

hacdias changed the title ~~Add TAR Gateway Format~~ Add TAR Gateway Response Format Jun 10, 2022

lidel requested changes Jun 14, 2022

View reviewed changes

lidel changed the title ~~Add TAR Gateway Response Format~~ RFC: TAR Gateway Response Format Jun 14, 2022

lidel mentioned this pull request Jun 14, 2022

Lightweight RFC Process #286

Closed

18 tasks

hacdias force-pushed the feat/gateway-tar branch from f14fe3a to fb5678f Compare June 16, 2022 11:26

hacdias requested a review from lidel June 16, 2022 11:26

lidel requested changes Jun 24, 2022

View reviewed changes

RFC/0000-gateway-tar-response-format.md Outdated Show resolved Hide resolved

RFC/0000-gateway-tar-response-format.md Outdated Show resolved Hide resolved

http-gateways/PATH_GATEWAY.md Outdated Show resolved Hide resolved

lidel changed the title ~~RFC: TAR Gateway Response Format~~ IPIP: TAR Gateway Response Format Jun 24, 2022

hacdias force-pushed the feat/gateway-tar branch 2 times, most recently from 8af8309 to 8023280 Compare June 30, 2022 10:55

hacdias requested a review from lidel June 30, 2022 12:18

Base automatically changed from feat/gateway-specs to main July 1, 2022 21:55

lidel force-pushed the main branch from 0188a6d to 947a78a Compare July 1, 2022 22:01

hacdias force-pushed the feat/gateway-tar branch from 358049d to b69968f Compare July 15, 2022 09:24

hacdias requested a review from a team as a code owner July 15, 2022 09:24

hacdias force-pushed the feat/gateway-tar branch from b69968f to 6db9b5e Compare July 15, 2022 09:26

SgtPooki approved these changes Jul 21, 2022

View reviewed changes

lidel self-assigned this Aug 4, 2022

hacdias force-pushed the feat/gateway-tar branch from 2cd86b4 to 9334f5e Compare August 15, 2022 16:41

hacdias added 4 commits September 1, 2022 20:52

docs: add TAR format

6be7dd1

refactor: cleanup markdown

e7a3572

refactor: cleanup markdown

3bdec5f

fix: grammar errors

992a0f3

ipip(tar): add info about root file/dir

a00ed4d

lidel reviewed Oct 10, 2022

View reviewed changes

IPIP/0000-gateway-tar-response-format.md Outdated Show resolved Hide resolved

Update IPIP/0000-gateway-tar-response-format.md

46aca5a

Co-authored-by: Marcin Rataj <lidel@lidel.org>

This comment was marked as outdated.

Sign in to view

hacdias added 4 commits October 12, 2022 12:47

improve test fixtures

64db0f0

Merge branch 'main' into feat/gateway-tar

354719f

lint path gateway

75dc76d

fix lint

49053ec

hacdias requested a review from lidel October 12, 2022 11:04

hacdias and others added 2 commits October 12, 2022 13:17

update title

dbd656c

ipip(tar): editorial tweaks

3766a6b

lidel approved these changes Oct 13, 2022

View reviewed changes

hacdias added 4 commits October 18, 2022 11:46

rfc --> ipip

e3bc88b

must -> should

101adf2

add TAR to response payload

26fb3be

Merge branch 'main' into feat/gateway-tar

8483a3b

lidel changed the title ~~IPIP: TAR Gateway Response Format~~ IPIP-288: TAR Gateway Response Format Oct 26, 2022

Merge branch 'main' into feat/gateway-tar

eea310a

lidel mentioned this pull request Nov 9, 2022

fix: error when TAR has files outside of root ipfs/go-ipfs-files#56

Merged

lidel pushed a commit to ipfs/go-ipfs-files that referenced this pull request Nov 9, 2022

fix: error when TAR has files outside of root (#56)

e8cf9a3

See "Security" section of IPIP-288 (ipfs/specs#288)

lidel added a commit to ipfs/kubo that referenced this pull request Nov 9, 2022

feat(gateway): TAR response format (#9029)

a210abd

Implementation of IPIP-288 (ipfs/specs#288) Co-authored-by: Marcin Rataj <lidel@lidel.org>

chore: editorial fixes

8fe745a

lidel force-pushed the feat/gateway-tar branch from 68eeda3 to 8fe745a Compare November 9, 2022 19:12

lidel merged commit 4cfabca into main Nov 9, 2022

lidel deleted the feat/gateway-tar branch November 9, 2022 19:15

hacdias added a commit to ipfs/boxo that referenced this pull request Jan 11, 2023

fix: error when TAR has files outside of root (#56)

83a75d2

See "Security" section of IPIP-288 (ipfs/specs#288) This commit was moved from ipfs/go-ipfs-files@e8cf9a3

hacdias added a commit to ipfs/boxo that referenced this pull request Jan 27, 2023

feat(gateway): TAR response format (#9029)

772fab3

Implementation of IPIP-288 (ipfs/specs#288) Co-authored-by: Marcin Rataj <lidel@lidel.org> This commit was moved from ipfs/kubo@a210abd

hannahhoward pushed a commit to filecoin-project/kubo-api-client that referenced this pull request Jun 19, 2023

feat(gateway): TAR response format (#9029)

15fbb50

Implementation of IPIP-288 (ipfs/specs#288) Co-authored-by: Marcin Rataj <lidel@lidel.org>

Conversation

hacdias commented Jun 10, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lidel left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hacdias commented Jun 16, 2022

Uh oh!

lidel left a comment • edited by hacdias Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hacdias commented Jun 30, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lidel commented Jul 11, 2022

Uh oh!

hacdias commented Jul 15, 2022

Uh oh!

SgtPooki left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

hacdias commented Oct 12, 2022

Uh oh!

lidel left a comment

Choose a reason for hiding this comment

Uh oh!

lidel commented Nov 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

hacdias commented Jun 10, 2022 •

edited

Loading

lidel left a comment •

edited

Loading

lidel left a comment •

edited by hacdias

Loading

hacdias commented Jun 30, 2022 •

edited

Loading

lidel commented Nov 9, 2022 •

edited

Loading