From f2bf366be4b9cf2e8e62d5fa76c0445ae2bad814 Mon Sep 17 00:00:00 2001 From: Henrique Dias Date: Tue, 27 Feb 2024 14:53:03 +0100 Subject: [PATCH] refactor: further doc cleanups --- config/gateway.go | 2 +- core/corehttp/gateway.go | 2 +- docs/gateway.md | 9 --------- 3 files changed, 2 insertions(+), 11 deletions(-) diff --git a/config/gateway.go b/config/gateway.go index fa093245d9a7..35af598b4359 100644 --- a/config/gateway.go +++ b/config/gateway.go @@ -9,7 +9,7 @@ const ( type GatewaySpec struct { // Paths is explicit list of path prefixes that should be handled by - // this gateway. Example: `["/ipfs", "/ipns", "/api"]` + // this gateway. Example: `["/ipfs", "/ipns"]` Paths []string // UseSubdomains indicates whether or not this gateway uses subdomains diff --git a/core/corehttp/gateway.go b/core/corehttp/gateway.go index 67e3c242d7b4..6ac3818856d5 100644 --- a/core/corehttp/gateway.go +++ b/core/corehttp/gateway.go @@ -235,7 +235,7 @@ func (o *offlineGatewayErrWrapper) GetDNSLinkRecord(ctx context.Context, s strin var _ gateway.IPFSBackend = (*offlineGatewayErrWrapper)(nil) -var defaultPaths = []string{"/ipfs/", "/ipns/", "/api/", "/p2p/"} +var defaultPaths = []string{"/ipfs/", "/ipns/", "/p2p/"} var subdomainGatewaySpec = &gateway.PublicGateway{ Paths: defaultPaths, diff --git a/docs/gateway.md b/docs/gateway.md index 531c8c6f94e0..ce849486c9b1 100644 --- a/docs/gateway.md +++ b/docs/gateway.md @@ -106,12 +106,3 @@ Right now only 'full DAG' implicit selector is implemented. Support for user-provided IPLD selectors is tracked in https://github.com/ipfs/kubo/issues/8769. This is a rough equivalent of `ipfs dag export`. - -## Deprecated Subset of RPC API - -For legacy reasons, some gateways may expose a small subset of RPC API under `/api/v0/`. -While this read-only API exposes a read-only, "safe" subset of the normal API, -it is deprecated and should not be used for greenfield projects. - -Where possible, leverage `/ipfs/` and `/ipns/` endpoints. -along with `application/vnd.ipld.*` Content-Types instead.