Skip to content

Commit 9470fd4

Browse files
committed
docs: editorial aspects to routing specs
1 parent 3b85317 commit 9470fd4

File tree

6 files changed

+43
-17
lines changed

6 files changed

+43
-17
lines changed

routing/ROUTING_V1_HTTP.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Routing V1 HTTP API
2+
3+
Moved to https://specs.ipfs.tech/routing/http-routing-v1/

src/architecture/principles.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ over arbitrary transports using a CID*. As Juan Benet once put it,
7070
Conversely, any system that exposes interactions with resources based on CIDs is
7171
an IPFS implementation. There are
7272
[many contexts in which CIDs can be used for addressing](https://docs.ipfs.tech/how-to/address-ipfs-on-web/)
73-
and [content routing delegation](https://github.com/ipfs/specs/blob/main/routing/ROUTING_V1_HTTP.md)
73+
and content routing delegation (:cite[http-routing-v1])
7474
can support a wealth of interaction options by resolving CIDs.
7575

7676
## Robustness

src/index.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,14 @@ <h3><a href="/ipns/">InterPlanetary Naming System</a></h3>
9494
</p>
9595
{% include 'list.html', posts: collections.ipns %}
9696
</section>
97+
<section>
98+
<h3><a href="/routing/">Routing</a></h3>
99+
<p>
100+
Content routing is the way to determine where to find a given CID on the network;
101+
specifically, which network peers provide specific CIDs.
102+
</p>
103+
{% include 'list.html', posts: collections.routing %}
104+
</section>
97105
<section>
98106
<h3><a href="/ipips/">InterPlanetary Improvement Proposals</a></h3>
99107
<p>

src/ipips/ipip-0337.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ and supporting large content providers is a key strategy for driving down IPFS c
2525
These providers must handle high volumes of traffic and support many users, so leveraging industry-standard tools and services
2626
such as HTTP load balancers, CDNs, reverse proxies, etc. is a requirement.
2727
To maximize compatibility with standard tools, IPFS needs an HTTP API specification that uses standard HTTP idioms and payload encoding.
28-
The [Reframe spec](https://github.com/ipfs/specs/blob/main/reframe/REFRAME_PROTOCOL.md) for delegated content routing is an experimental attempt at this,
28+
The Reframe spec for delegated content routing is an experimental attempt at this,
2929
but it has resulted in a very unidiomatic HTTP API which is difficult to implement and is incompatible with many existing tools.
3030
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.
3131

@@ -36,13 +36,13 @@ We expect this API to be extended beyond "content routing" in the future, so add
3636

3737
## Detailed design
3838

39-
See the [Delegated Content Routing HTTP API spec](../routing/DELEGATED_CONTENT_ROUTING_HTTP.md) included with this IPIP.
39+
See the Delegated Content Routing HTTP API spec (:cite[http-routing-v1]) included with this IPIP.
4040

4141
## Design rationale
4242

4343
To understand the design rationale, it is important to consider the concrete Reframe limitations that we know about:
4444

45-
- Reframe [method types](../reframe/REFRAME_KNOWN_METHODS.md) using the HTTP transport are encoded inside IPLD-encoded messages
45+
- Reframe method types using the HTTP transport are encoded inside IPLD-encoded messages
4646
- This prevents URL-based pattern matching on methods, which makes it hard and expensive to do basic HTTP scaling and optimizations:
4747
- Configuring different caching strategies for different methods
4848
- Configuring reverse proxies on a per-method basis

src/routing/http-routing-v1.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
1-
# Routing v1 HTTP API
2-
3-
![reliable](https://img.shields.io/badge/status-reliable-green.svg?style=flat-square) Delegated Content Routing HTTP API
4-
5-
**Author(s)**:
6-
7-
- Gus Eggert
8-
9-
**Maintainer(s)**:
10-
11-
* * *
12-
13-
**Abstract**
1+
---
2+
title: Routing V1 HTTP API
3+
description: >
4+
Delegated content routing is a mechanism for IPFS implementations to use for
5+
offloading content routing to another process. This specification describes
6+
an HTTP API for delegated content routing.
7+
date: 2023-03-22
8+
maturity: reliable
9+
editors:
10+
- name: Gus Eggert
11+
github: guseggert
12+
order: 0
13+
tags: ['routing']
14+
---
1415

1516
"Delegated content routing" is a mechanism for IPFS implementations to use for offloading content routing to another process/server. This spec describes an HTTP API for delegated content routing.
1617

src/routing/index.html

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: Routing
3+
description: |
4+
Content routing is the way to determine where to find a given CID on the network;
5+
specifically, which network peers provide specific CIDs.
6+
---
7+
8+
{% include 'header.html' %}
9+
10+
<main>
11+
{% include 'list.html', posts: collections.routing %}
12+
</main>
13+
14+
{% include 'footer.html' %}

0 commit comments

Comments
 (0)