Skip to content

Commit

Permalink
chore: apply suggestions from code review
Browse files Browse the repository at this point in the history
  • Loading branch information
lidel authored May 18, 2023
1 parent cb84b24 commit 49fef6c
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
4 changes: 1 addition & 3 deletions IPIP/0379-delegated-ipns-http-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,13 +65,11 @@ Implements are permitted to set a lower limit. If lower than the default maximum
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.

Privacy in delegated IPNS is out of scope for this work.
- The usual JSON parsing rules apply. To prevent potential Denial of Service (DoS) attack, clients should ignore responses larger than 100 providers and introduce a byte size limit that is applicable to their use case.

### Alternatives

See:
- [Libp2p-based IPNS](https://github.com/ipfs/go-ipns).
- Reframe; find out more on [IPIP-337 Design Rationale](0337-delegated-routing-http-api.md#design-rationale).
- Reframe; it was deprecated and now removed. Historical reasons can be found in [IPIP-337 Design Rationale](https://specs.ipfs.tech/ipips/ipip-0337/#design-rationale).

### Copyright

Expand Down
6 changes: 4 additions & 2 deletions routing/DELEGATED_IPNS_HTTP.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,8 @@ Where:
cached.
- `PublicKey` represents the optional public key used to sign the record. This field is only
required if it cannot be extracted from the IPNS name, e.g. in the case of legacy RSA keys.
The idea here is that IPNS Record should always have all information neccessary
for signature verification in offline mode, without additional lookups to retrieve the public key.
- `ExtendedData` represents the extensible data as arbitrary JSON object.

## Versioning
Expand All @@ -80,7 +82,7 @@ increment the version number.

## API

### `GET /naming/v1/records/{ipns-name}`
### `GET /routing/v1/ipns/{ipns-name}`

**Path Parameters**

Expand Down Expand Up @@ -120,7 +122,7 @@ The response body contains the [IPNS record](#ipns-record).
}
```

### `PUT /naming/v1/records/{ipns-name}`
### `PUT /routing/v1/ipns/{ipns-name}`

**Path Parameters**

Expand Down

0 comments on commit 49fef6c

Please sign in to comment.