Skip to content

Commit 8c977f7

Browse files
Bumped go-ipfs dependence of http-api-docs to tag v0.9.1.
1 parent 3e9cbd1 commit 8c977f7

File tree

4 files changed

+65
-49
lines changed

4 files changed

+65
-49
lines changed

docs/reference/cli.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ description: API documentation for the Go-IPFS command-line executable.
77

88
<!-- DO NOT EDIT THIS FILE. This file is auto-generated from `generate-cli-docs.sh`. Any changes you make to this file will be overwritten. To edit this file, change the contents of the `generate-cli-docs.sh` script. -->
99

10-
IPFS can run in either _online_ or _offline_ mode. Online mode is when you have IPFS running separately as a daemon process. If you do not have an IPFS daemon running, you are in offline mode. Some commands, like `ipfs swarm peers`, are only supported when online. The [command-line quickstart guide](../how-to/command-line-quick-start.md#take-your-node-online) explains how to start the IPFS daemon and take your node online.
10+
IPFS can run in either _online_ or _offline_ mode. Online mode is when you have IPFS running separately as a daemon process. If you do not have an IPFS daemon running, you are in offline mode. Some commands, like `ipfs swarm peers`, are only supported when online. The [command-line quickstart guide](../how-to/command-line-quick-start/#take-your-node-online) explains how to start the IPFS daemon and take your node online.
1111

1212

1313

1414
### Alignment with HTTP API
1515

16-
Every command usable from the CLI is also available through the [HTTP API](http/api.md). For example:
16+
Every command usable from the CLI is also available through the [HTTP API](/reference/http/api). For example:
1717

1818
```sh
1919
> ipfs swarm peers
@@ -32,7 +32,7 @@ Every command usable from the CLI is also available through the [HTTP API](http/
3232
```
3333

3434

35-
_Generated on 2021-06-23 12:01:39, from go-ipfs 0.9.0._
35+
_Generated on 2021-09-20 21:03:27, from go-ipfs 0.9.1._
3636

3737
## ipfs
3838

@@ -891,29 +891,24 @@ SYNOPSIS
891891
DESCRIPTION
892892
893893
Available profiles:
894-
'server':
895-
Disables local host discovery, recommended when
896-
running IPFS on machines with public IPv4 addresses.
897-
'local-discovery':
898-
Sets default values to fields affected by the server
899-
profile, enables discovery in local networks.
900-
'test':
901-
Reduces external interference of IPFS daemon, this
902-
is useful when using the daemon in test environments.
903894
'default-datastore':
904895
Configures the node to use the default datastore (flatfs).
905896
906897
Read the "flatfs" profile description for more information on this datastore.
907898
908899
This profile may only be applied when first initializing the node.
909900
910-
'lowpower':
911-
Reduces daemon overhead on the system. May affect node
912-
functionality - performance of content discovery and data
913-
fetching may be degraded.
914-
915901
'randomports':
916902
Use a random port number for swarm.
903+
'server':
904+
Disables local host discovery, recommended when
905+
running IPFS on machines with public IPv4 addresses.
906+
'local-discovery':
907+
Sets default values to fields affected by the server
908+
profile, enables discovery in local networks.
909+
'test':
910+
Reduces external interference of IPFS daemon, this
911+
is useful when using the daemon in test environments.
917912
'default-networking':
918913
Restores default network settings.
919914
Inverse profile of the test profile.
@@ -949,6 +944,11 @@ DESCRIPTION
949944
* This datastore uses up to several gigabytes of memory.
950945
951946
This profile may only be applied when first initializing the node.
947+
'lowpower':
948+
Reduces daemon overhead on the system. May affect node
949+
functionality - performance of content discovery and data
950+
fetching may be degraded.
951+
952952
953953
SUBCOMMANDS
954954
ipfs config profile apply <profile> - Apply profile to config.

docs/reference/http/api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: HTTP API reference for IPFS, the InterPlanetary File System.
99
<!-- TODO: Describe how to change ports and configure the API server -->
1010
<!-- TODO: Structure this around command groups (dag, object, files, etc.) -->
1111

12-
_Generated on 2021-06-23, from go-ipfs v0.9.0._
12+
_Generated on 2021-09-20, from go-ipfs v0.9.1._
1313

1414
When an IPFS node is running as a daemon, it exposes an HTTP API that allows you to control the node and run the same commands you can from the command line.
1515

@@ -55,7 +55,7 @@ Arguments are added through the special query string key "arg":
5555
}
5656
```
5757

58-
Note that it can be used multiple times to signify multiple arguments. Boolean `bool` values may have the value `true` or `false`.
58+
Note that it can be used multiple times to signify multiple arguments.
5959

6060
### Flags
6161

@@ -739,7 +739,7 @@ Format and convert a CID in various useful ways.
739739
### Arguments
740740

741741
- `arg` [string]: Cids to format. Required: **yes**.
742-
- `f` [string]: Printf style format string. Default: %!s(MISSING). Default: `%!s(MISSING)`. Required: no.
742+
- `f` [string]: Printf style format string. Default: %s. Default: `%s`. Required: no.
743743
- `v` [string]: CID version to convert to. Required: no.
744744
- `codec` [string]: CID codec to convert to. Required: no.
745745
- `b` [string]: Multibase to display CID in. Required: no.

tools/http-api-docs/go.mod

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ go 1.16
55
require (
66
github.com/Stebalien/go-json-doc v0.0.2
77
github.com/ipfs/go-cid v0.0.7
8-
github.com/ipfs/go-ipfs v0.9.0
8+
github.com/ipfs/go-ipfs v0.9.1
99
github.com/ipfs/go-ipfs-cmds v0.6.0
1010
github.com/libp2p/go-libp2p-core v0.8.5
11-
github.com/multiformats/go-multiaddr v0.3.2
11+
github.com/multiformats/go-multiaddr v0.3.3
1212
)

0 commit comments

Comments
 (0)