Skip to content

Commit 6dc20dd

Browse files
committed
refactor: further doc cleanups
1 parent 8357ccb commit 6dc20dd

File tree

3 files changed

+2
-11
lines changed

3 files changed

+2
-11
lines changed

config/gateway.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ const (
99

1010
type GatewaySpec struct {
1111
// Paths is explicit list of path prefixes that should be handled by
12-
// this gateway. Example: `["/ipfs", "/ipns", "/api"]`
12+
// this gateway. Example: `["/ipfs", "/ipns"]`
1313
Paths []string
1414

1515
// UseSubdomains indicates whether or not this gateway uses subdomains

core/corehttp/gateway.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ func (o *offlineGatewayErrWrapper) GetDNSLinkRecord(ctx context.Context, s strin
235235

236236
var _ gateway.IPFSBackend = (*offlineGatewayErrWrapper)(nil)
237237

238-
var defaultPaths = []string{"/ipfs/", "/ipns/", "/api/", "/p2p/"}
238+
var defaultPaths = []string{"/ipfs/", "/ipns/", "/p2p/"}
239239

240240
var subdomainGatewaySpec = &gateway.PublicGateway{
241241
Paths: defaultPaths,

docs/gateway.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -106,12 +106,3 @@ Right now only 'full DAG' implicit selector is implemented.
106106
Support for user-provided IPLD selectors is tracked in https://github.com/ipfs/kubo/issues/8769.
107107

108108
This is a rough equivalent of `ipfs dag export`.
109-
110-
## Deprecated Subset of RPC API
111-
112-
For legacy reasons, some gateways may expose a small subset of RPC API under `/api/v0/`.
113-
While this read-only API exposes a read-only, "safe" subset of the normal API,
114-
it is deprecated and should not be used for greenfield projects.
115-
116-
Where possible, leverage `/ipfs/` and `/ipns/` endpoints.
117-
along with `application/vnd.ipld.*` Content-Types instead.

0 commit comments

Comments
 (0)