docs: clean mentions of go-ipfs-api, go-ipfs-http-api
Henrique Dias committed
Oct 9, 2023 at 11:18 UTC
4c043112579733b6a91cf401104b713281ab01bb
3 files changed
+4
-86
core/coreapi/coreapi.go
+4
-7
@@ -1,15 +1,12 @@
1
/*
2
+**NOTE: this package is experimental.**
3
+
4
Package coreapi provides direct access to the core commands in IPFS. If you are
5
embedding IPFS directly in your Go program, this package is the public
6
interface you should use to read and write files or otherwise control IPFS.
7
6
-If you are running IPFS as a separate process, you should use `go-ipfs-api` to
7
-work with it via HTTP. As we finalize the interfaces here, `go-ipfs-api` will
8
-transparently adopt them so you can use the same code with either package.
9
-
10
-**NOTE: this package is experimental.** `go-ipfs` has mainly been developed
11
-as a standalone application and library-style use of this package is still new.
12
-Interfaces here aren't yet completely stable.
8
+If you are running IPFS as a separate process, you should use `client/rpc` to
9
+work with it via HTTP.
10
*/
11
package coreapi
12
docs/http-rpc-clients.md
-6
@@ -2,12 +2,6 @@
2
3
Kubo provides official HTTP RPC (`/api/v0`) clients for selected languages:
4
5
-- [`js-kubo-rpc-client`](https://github.com/ipfs/js-kubo-rpc-client) - Official JS client for talking to Kubo RPC over HTTP
6
-- [`go-ipfs-api`](https://github.com/ipfs/go-ipfs-api) - The go interface to ipfs's HTTP RPC - Follow https://github.com/ipfs/kubo/issues/9124 for coming changes.
7
-- [`httpapi`](./client/rpc) (previously `go-ipfs-http-client`) - [`coreiface.CoreAPI`](https://pkg.go.dev/github.com/ipfs/boxo/coreiface#CoreAPI) implementation using HTTP RPC
8
-
9
-## Recommended clients
10
-
5
| Language | Package Name | Github Repository |
6
|:--------:|:-------------------:|--------------------------------------------|
7
| JS | kubo-rpc-client | https://github.com/ipfs/js-kubo-rpc-client |
package-list.json
deleted
-73
@@ -1,73 +0,0 @@
1
-{
2
- "columns": [
3
- "Name",
4
- "CI/Travis",
5
- "Coverage",
6
- "Description"
7
- ],
8
- "rows": [
9
- "Libp2p",
10
- ["libp2p/go-libp2p", "go-libp2p", "p2p networking library"],
11
- ["libp2p/go-libp2p-pubsub", "go-libp2p-pubsub", "pubsub built on libp2p"],
12
- ["libp2p/go-libp2p-kad-dht", "go-libp2p-kad-dht", "dht-backed router"],
13
- ["libp2p/go-libp2p-pubsub-router", "go-libp2p-pubsub-router", "pubsub-backed router"],
14
-
15
- "Multiformats",
16
- ["ipfs/go-cid", "go-cid", "CID implementation"],
17
- ["multiformats/go-multiaddr", "go-multiaddr", "multiaddr implementation"],
18
- ["multiformats/go-multihash", "go-multihash", "multihash implementation"],
19
- ["multiformats/go-multibase", "go-multibase", "mulitbase implementation"],
20
-
21
- "Files",
22
- ["ipfs/go-unixfs", "go-unixfs", "the core 'filesystem' logic"],
23
- ["ipfs/go-mfs", "go-mfs", "a mutable filesystem editor for unixfs"],
24
- ["ipfs/go-ipfs-posinfo", "go-ipfs-posinfo", "helper datatypes for the filestore"],
25
- ["ipfs/go-ipfs-chunker", "go-ipfs-chunker", "file chunkers"],
26
-
27
- "Exchange",
28
- ["ipfs/go-ipfs-exchange-interface", "go-ipfs-exchange-interface", "exchange service interface"],
29
- ["ipfs/go-ipfs-exchange-offline", "go-ipfs-exchange-offline", "(dummy) offline implementation of the exchange service"],
30
- ["ipfs/go-bitswap", "go-bitswap", "bitswap protocol implementation"],
31
- ["ipfs/go-blockservice", "go-blockservice", "service that plugs a blockstore and an exchange together"],
32
-
33
- "Datastores",
34
- ["ipfs/go-datastore", "go-datastore", "datastore interfaces, adapters, and basic implementations"],
35
- ["ipfs/go-ipfs-ds-help", "go-ipfs-ds-help", "datastore utility functions"],
36
- ["ipfs/go-ds-flatfs", "go-ds-flatfs", "a filesystem-based datastore"],
37
- ["ipfs/go-ds-measure", "go-ds-measure", "a metric-collecting database adapter"],
38
- ["ipfs/go-ds-leveldb", "go-ds-leveldb", "a leveldb based datastore"],
39
- ["ipfs/go-ds-badger", "go-ds-badger", "a badgerdb based datastore"],
40
-
41
- "Namesys",
42
- ["ipfs/go-ipns", "go-ipns", "IPNS datastructures and validation logic"],
43
-
44
- "Repo",
45
- ["ipfs/go-fs-lock", "go-fs-lock", "lockfile management functions"],
46
- ["ipfs/fs-repo-migrations", "fs-repo-migrations", "repo migrations"],
47
-
48
- "IPLD",
49
- ["ipfs/go-block-format", "go-block-format", "block interfaces and implementations"],
50
- ["ipfs/go-ipfs-blockstore", "go-ipfs-blockstore", "blockstore interfaces and implementations"],
51
- ["ipfs/go-ipld-format", "go-ipld-format", "IPLD interfaces"],
52
- ["ipfs/go-ipld-cbor", "go-ipld-cbor", "IPLD-CBOR implementation"],
53
- ["ipfs/go-ipld-git", "go-ipld-git", "IPLD-Git implementation"],
54
- ["ipfs/go-merkledag", "go-merkledag", "IPLD-Merkledag implementation (and then some)"],
55
-
56
- "Commands",
57
- ["ipfs/go-ipfs-cmds", "go-ipfs-cmds", "CLI & HTTP commands library"],
58
- ["ipfs/go-ipfs-files", "go-ipfs-files", "CLI & HTTP commands library"],
59
- ["ipfs/go-ipfs-api", "go-ipfs-api", "an old, stable shell for the IPFS HTTP API"],
60
- ["ipfs/go-ipfs-http-client", "go-ipfs-http-client", "a new, unstable shell for the IPFS HTTP API"],
61
- ["ipfs/interface-go-ipfs-core", "interface-go-ipfs-core", "core go-ipfs API interface definitions"],
62
-
63
- "Metrics & Logging",
64
- ["ipfs/go-metrics-interface", "go-metrics-interface", "metrics collection interfaces"],
65
- ["ipfs/go-metrics-prometheus", "go-metrics-prometheus", "prometheus-backed metrics collector"],
66
- ["ipfs/go-log", "go-log", "logging framework"],
67
-
68
- "Generics/Utils",
69
- ["ipfs/go-ipfs-routing", "go-ipfs-routing", "routing (content, peer, value) helpers"],
70
- ["ipfs/go-ipfs-util", "go-ipfs-util", "the kitchen sink"],
71
- ["ipfs/go-ipfs-addr", "go-ipfs-addr", "utility functions for parsing IPFS multiaddrs"]
72
- ]
73
-}