Skip to content

Bump CLI and HTTP API reference to go-ipfs v0.9.1 #887

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 22, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions docs/reference/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ description: API documentation for the Go-IPFS command-line executable.

<!-- 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. -->

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.
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.



### Alignment with HTTP API

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

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


_Generated on 2021-06-23 12:01:39, from go-ipfs 0.9.0._
_Generated on 2021-09-21 20:56:55, from go-ipfs 0.9.1._

## ipfs

Expand Down Expand Up @@ -894,12 +894,12 @@ DESCRIPTION
'server':
Disables local host discovery, recommended when
running IPFS on machines with public IPv4 addresses.
'local-discovery':
Sets default values to fields affected by the server
profile, enables discovery in local networks.
'test':
Reduces external interference of IPFS daemon, this
is useful when using the daemon in test environments.
'default-networking':
Restores default network settings.
Inverse profile of the test profile.
'default-datastore':
Configures the node to use the default datastore (flatfs).

Expand All @@ -912,11 +912,9 @@ DESCRIPTION
functionality - performance of content discovery and data
fetching may be degraded.

'randomports':
Use a random port number for swarm.
'default-networking':
Restores default network settings.
Inverse profile of the test profile.
'local-discovery':
Sets default values to fields affected by the server
profile, enables discovery in local networks.
'flatfs':
Configures the node to use the flatfs datastore.

Expand Down Expand Up @@ -949,6 +947,8 @@ DESCRIPTION
* This datastore uses up to several gigabytes of memory.

This profile may only be applied when first initializing the node.
'randomports':
Use a random port number for swarm.

SUBCOMMANDS
ipfs config profile apply <profile> - Apply profile to config.
Expand Down
9 changes: 3 additions & 6 deletions docs/reference/http/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: HTTP API reference for IPFS, the InterPlanetary File System.
<!-- TODO: Describe how to change ports and configure the API server -->
<!-- TODO: Structure this around command groups (dag, object, files, etc.) -->

_Generated on 2021-06-23, from go-ipfs v0.9.0._
_Generated on 2021-09-21, from go-ipfs v0.9.1._

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.

Expand Down Expand Up @@ -55,7 +55,7 @@ Arguments are added through the special query string key "arg":
}
```

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

### Flags

Expand Down Expand Up @@ -739,7 +739,7 @@ Format and convert a CID in various useful ways.
### Arguments

- `arg` [string]: Cids to format. Required: **yes**.
- `f` [string]: Printf style format string. Default: %!s(MISSING). Default: `%!s(MISSING)`. Required: no.
- `f` [string]: Printf style format string. Default: %s. Default: `%s`. Required: no.
- `v` [string]: CID version to convert to. Required: no.
- `codec` [string]: CID codec to convert to. Required: no.
- `b` [string]: Multibase to display CID in. Required: no.
Expand Down Expand Up @@ -3173,9 +3173,6 @@ Pin objects to local storage.

On success, the call to this endpoint will return with 200 and the following body:

- `Pins` [string]: List of completed pins.
- `Progress` [int]: Number of blocks pinned so far.

```json
{
"Pins": [
Expand Down
4 changes: 2 additions & 2 deletions tools/http-api-docs/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ go 1.16
require (
github.com/Stebalien/go-json-doc v0.0.2
github.com/ipfs/go-cid v0.0.7
github.com/ipfs/go-ipfs v0.9.0
github.com/ipfs/go-ipfs v0.9.1
github.com/ipfs/go-ipfs-cmds v0.6.0
github.com/libp2p/go-libp2p-core v0.8.5
github.com/multiformats/go-multiaddr v0.3.2
github.com/multiformats/go-multiaddr v0.3.3
)
Loading