Skip to content

Commit 1aca148

Browse files
committed
docs: remove application/json from ipip
1 parent 8d73d72 commit 1aca148

File tree

1 file changed

+2
-7
lines changed

1 file changed

+2
-7
lines changed

src/ipips/ipip-0379.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,6 @@ order: 379
1818
tags: ['ipips']
1919
---
2020

21-
- Start Date: 2023-02-13
22-
- Related Issues:
23-
2421
## Summary
2522

2623
This IPIP specifies a set of HTTP APIs to offload naming system onto another process or server.
@@ -40,8 +37,7 @@ The rationale for delegated IPNS over HTTP APIs closely follows the reasoning li
4037

4138
The document proposes the following:
4239
- Use of HTTP semantics for publication and resolution of naming records.
43-
- Preference for human-readable request and response encoding, such as JSON format
44-
- Mandatory support for the existing :ref[IPNS Record] serialization format using `Content-Type: application/vnd.ipfs.ipns-record`
40+
- Use of existing :ref[IPNS Record] serialization format through `Content-Type: application/vnd.ipfs.ipns-record`.
4541
- Use of extra headers in `OPTIONS` response to communicate the supported capabilities and limitations, namely:
4642
- `X-Ipns-Allow-Max-Size` -- to signal maximum supported IPNS record size
4743
- `X-Ipns-Allow-Protobuf` -- to signal whether the server supports ProtocolBuffer formatted records.
@@ -62,7 +58,6 @@ This format is widely in use in IPNS over PubSub and DHT routing systems.
6258
One of the motivations of this document is to introduce simple to use HTTP APIs and ultimately reduce barrier for interaction across alternative systems.
6359
Further, interoperability across the existing and HTTP APIs is also desirable in order to reduce the barrier for adoption of the delegated HTTP APIs.
6460

65-
The specification here maintains backwards compatibility in terms of record serialisation, with preference for human-readable formats such as JSON.
6661
To maximize interoperability with existing ecosystem, the canonical IPNS record serialization format :cite[ipns-record] (`0x0300`) can be requested with content type `application/vnd.ipfs.ipns-record`.
6762

6863
#### Compatibility
@@ -74,7 +69,7 @@ See "Compatibility" section of :cite[ipip-0337].
7469
All interaction over the APIs should use TLS to protect against third-party observation and tampering.
7570
Additionally, the IPNS records must be validated according to the rules stated in :cite[ipns-record] before further processing.
7671

77-
To avoid Denial of Service attack, [maximum IPNS record size defined in IPNS spec](https://specs.ipfs.tech/ipns/ipns-record/#record-size-limit) applies.
72+
To avoid Denial of Service attack, maximum IPNS record size defined in :cite[ipns-record] applies.
7873
Implements are permitted to set a lower limit. If lower than the default maximum, the limit should be discoverable via `OPTIONS` request with header key `X-Ipns-Allow-Max-Size` with value specified as the number of bytes.
7974

8075
Similarly, a client may check if a server supports ProtocolBuffer formatted records by checking the `X-Ipns-Allow-Protobuf` header key in response to `OPTIONS` request. If present the header value must be either `true` or `false` the absence of the header indicates that ProtocolBuffer formatted records are not supported.

0 commit comments

Comments
 (0)