You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: IPIP/0337-delegated-routing-http-api.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -70,7 +70,7 @@ So this API proposal makes the following changes:
70
70
- Multiaddrs use the [human-readable format](https://github.com/multiformats/multiaddr#specification) that is used in existing tools and Kubo CLI commands such as `ipfs id` or `ipfs swarm peers`
71
71
- Byte array values, such as signatures, are multibase-encoded strings (with an `m` prefix indicating Base64)
72
72
- The "Identify" method and "message groups" are not included
73
-
- The "GetIPNS" and "PutIPNS" methods are not included. Instead, a separate Delegated Naming HTTP API aims to firstly facilitate naming system delegation, and secondly, pave the way for future iterations of IPNS with less interdependency with content routing. For more information, see [Delegated Naming HTTP API](0379-delegated-naming-http-api.md).
73
+
- The "GetIPNS" and "PutIPNS" methods are not included. Instead, a separate Delegated IPNS HTTP API aims to firstly facilitate naming system delegation, and secondly, pave the way for future iterations of IPNS with less interdependency with content routing. For more information, see [Delegated IPNS HTTP API](0379-delegated-ipns-http-api.md).
Copy file name to clipboardExpand all lines: IPIP/0379-delegated-ipns-http-api.md
+6-7Lines changed: 6 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# IPIP-379: Delegated Naming HTTP API
1
+
# IPIP-379: Delegated IPNS HTTP API
2
2
3
3
- Start Date: 2023-02-13
4
4
- Related Issues:
@@ -8,7 +8,7 @@
8
8
9
9
## Summary
10
10
11
-
This IPIP specifies a set of HTTP APIs to offload naming system onto aother process or server.
11
+
This IPIP specifies a set of HTTP APIs to offload naming system onto another process or server.
12
12
13
13
## Motivation
14
14
@@ -21,13 +21,13 @@ See [Delegated Naming HTTP API](../routing/DELEGATED_NAMING_HTTP.md) specificati
21
21
22
22
## Design rationale
23
23
24
-
The rationale for delegated naming over HTTP APIs closely follows the reasoning listed in [IPIP-337](0337-delegated-routing-http-api.md#design-rationale).
24
+
The rationale for delegated IPNS over HTTP APIs closely follows the reasoning listed in [IPIP-337](0337-delegated-routing-http-api.md#design-rationale).
25
25
26
26
The document proposes the following:
27
27
- Use of HTTP semantics for publication and resolution of naming records.
28
28
- Preference for human-readable request and response encoding, such as JSON format
29
-
- Optional backward compatibility support for the existing ProtocolBuffer format using `Content-Type: application/x-protobuf; messageType="IpnsEntry"`
30
-
- Use of extra headers in `OPTIONS` response to communicate the supported cpabilities and limitations, namely:
29
+
- Optional backward compatibility support for the existing ProtocolBuffer format using `Content-Type: application/vnd.ipfs.ipns-record`
30
+
- Use of extra headers in `OPTIONS` response to communicate the supported capabilities and limitations, namely:
31
31
-`X-Ipns-Allow-Max-Size` -- to signal maximum supported IPNS record size
32
32
-`X-Ipns-Allow-Protobuf` -- to signal whether the server supports ProtocolBuffer formatted records.
33
33
- Streaming interaction is not supported.
@@ -48,8 +48,7 @@ One of the motivations of this document is to introduce simple to use HTTP APIs
48
48
Further, interoperability across the existing and HTTP APIs is also desirable in order to reduce the barrier for adoption of the delegated HTTP APIs.
49
49
50
50
The specification here maintains backwards compatibility in terms of record serialisation, with preference for human-readable formats such as JSON.
51
-
To maintain backwards compatibility, the implementers of the HTTP API should accept requests with following `Content-Type` header:
To maximize interoperability with existing ecosystem, the canonical [IPNS record serialization format](../ipns/IPNS.md#record-serialization-format) (`0x0300`) can be requested with content type `application/vnd.ipfs.ipns-record`.
0 commit comments