Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: fix broken link in IPIP-337 #396

Closed
wants to merge 2 commits into from
Closed

chore: fix broken link in IPIP-337 #396

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2fb03a4
Update 0337-delegated-routing-http-api.md
TorfinnOlsen Apr 3, 2023
020c43d
Update 0337-delegated-routing-http-api.md
TorfinnOlsen Apr 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions IPIP/0337-delegated-routing-http-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,11 @@ and supporting large content providers is a key strategy for driving down IPFS c
These providers must handle high volumes of traffic and support many users, so leveraging industry-standard tools and services
such as HTTP load balancers, CDNs, reverse proxies, etc. is a requirement.
To maximize compatibility with standard tools, IPFS needs an HTTP API specification that uses standard HTTP idioms and payload encoding.
The [Reframe spec](https://github.com/ipfs/specs/blob/main/reframe/REFRAME_PROTOCOL.md) for delegated content routing is an experimental attempt at this,
but it has resulted in a very unidiomatic HTTP API which is difficult to implement and is incompatible with many existing tools.
The cost of a proper redesign, implementation, and maintenance of Reframe and its implementation is too high relative to the urgency of having a delegated content routing HTTP API.

Note that this does not supplant nor deprecate Reframe. Ideally in the future, Reframe and its implementation would receive the resources needed to map the IDL to idiomatic HTTP,
and implementations of this spec could then be rewritten in the IDL, maintaining backwards compatibility.
Previously the Reframe spec for delegated content routing was an experimental attempt at this, but has been deprecated for two Kubo releases(v0.17,v0.18). Reframe had resulted in a very unidiomatic HTTP API which was difficult to implement and was incompatible with many existing tools.
The cost of a proper redesign, implementation, maintenance of Reframe, and its implementation were too high relative to the urgency of having a delegated content routing HTTP API. All refererences to Reframe in code and specs were removed in Kubo release v0.19 with [Reframe cleanup](https://github.com/ipfs/kubo/issues/9479).

We expect this API to be extended beyond "content routing" in the future, so additional IPIPs may rename this to something more general such as "Delegated Routing HTTP API".
We expect this API to be extended beyond "content routing" in the future, so additional IPIPs may rename this to something more general such as "Routing V1".

## Detailed design

Expand Down