Bumped go-ipfs dependence of http-api-docs to tag v0.9.1.

ipfs · Sep 20, 2021 · 8c977f7 · 8c977f7
1 parent 3e9cbd1
commit 8c977f7
Show file tree

Hide file tree

Showing 4 changed files with 65 additions and 49 deletions.
diff --git a/docs/reference/cli.md b/docs/reference/cli.md
@@ -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
@@ -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-20 21:03:27, from go-ipfs 0.9.1._
 
 ## ipfs
 
@@ -891,29 +891,24 @@ SYNOPSIS
 DESCRIPTION
 
   Available profiles:
-    '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-datastore':
       Configures the node to use the default datastore (flatfs).
       
       Read the "flatfs" profile description for more information on this datastore.
       
       This profile may only be applied when first initializing the node.
       
-    'lowpower':
-      Reduces daemon overhead on the system. May affect node
-      functionality - performance of content discovery and data
-      fetching may be degraded.
-      
     'randomports':
       Use a random port number for swarm.
+    '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.
@@ -949,6 +944,11 @@ DESCRIPTION
       * This datastore uses up to several gigabytes of memory. 
       
       This profile may only be applied when first initializing the node.
+    'lowpower':
+      Reduces daemon overhead on the system. May affect node
+      functionality - performance of content discovery and data
+      fetching may be degraded.
+      
 
 SUBCOMMANDS
   ipfs config profile apply <profile> - Apply profile to config.

diff --git a/docs/reference/http/api.md b/docs/reference/http/api.md
@@ -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-20, 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.
 
@@ -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
 
@@ -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.

diff --git a/tools/http-api-docs/go.mod b/tools/http-api-docs/go.mod
@@ -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
 )