Skip to content

Commit c5c9649

Browse files
committed
Fix spelling mistakes and use IPNS terminology
1 parent 153a876 commit c5c9649

File tree

2 files changed

+7
-8
lines changed

2 files changed

+7
-8
lines changed

IPIP/0337-delegated-routing-http-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ So this API proposal makes the following changes:
7070
- 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`
7171
- Byte array values, such as signatures, are multibase-encoded strings (with an `m` prefix indicating Base64)
7272
- 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).
7474

7575
### User benefit
7676

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# IPIP-379: Delegated Naming HTTP API
1+
# IPIP-379: Delegated IPNS HTTP API
22

33
- Start Date: 2023-02-13
44
- Related Issues:
@@ -8,7 +8,7 @@
88

99
## Summary
1010

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.
1212

1313
## Motivation
1414

@@ -21,13 +21,13 @@ See [Delegated Naming HTTP API](../routing/DELEGATED_NAMING_HTTP.md) specificati
2121

2222
## Design rationale
2323

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).
2525

2626
The document proposes the following:
2727
- Use of HTTP semantics for publication and resolution of naming records.
2828
- 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:
3131
- `X-Ipns-Allow-Max-Size` -- to signal maximum supported IPNS record size
3232
- `X-Ipns-Allow-Protobuf` -- to signal whether the server supports ProtocolBuffer formatted records.
3333
- Streaming interaction is not supported.
@@ -48,8 +48,7 @@ One of the motivations of this document is to introduce simple to use HTTP APIs
4848
Further, interoperability across the existing and HTTP APIs is also desirable in order to reduce the barrier for adoption of the delegated HTTP APIs.
4949

5050
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:
52-
- `application/x-protobuf; messageType="IpnsEntry"`
51+
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`.
5352

5453
##### Reframe
5554

0 commit comments

Comments
 (0)