Merge pull request #2208 from filecoin-project/add/api-docs-automation

Adds automation for JSON-RPC docs content creation.

Author: johnnymatthews

.gitbook.yaml

@@ -168,6 +168,7 @@ redirects:
   reference/general: reference/general/README.md
   reference/general/overview: reference/general/README.md
   reference/glossary: reference/general/glossary.md
+  reference/json-rpc/beacon: reference/general/README.md
   reference/json-rpc/introduction: reference/json-rpc/README.md
   reference/reference/glossary: reference/general/glossary.md
   reference/reference/overview: reference/general/README.md

SUMMARY.md

@@ -153,7 +153,6 @@
   * [Filecoin.sol](reference/built-in-actors/filecoin.sol.md)
 * [JSON-RPC](reference/json-rpc/README.md)
   * [Auth](reference/json-rpc/auth.md)
-  * [Beacon](reference/json-rpc/beacon.md)
   * [Chain](reference/json-rpc/chain.md)
   * [Client](reference/json-rpc/client.md)
   * [Create](reference/json-rpc/create.md)
@@ -166,7 +165,11 @@
   * [Mpool](reference/json-rpc/mpool.md)
   * [Msig](reference/json-rpc/msig.md)
   * [Net](reference/json-rpc/net.md)
+  * [Node](reference/json-rpc/node.md)
   * [Paych](reference/json-rpc/paych.md)
+  * [Raft](reference/json-rpc/raft.md)
+  * [Start](reference/json-rpc/start.md)
   * [State](reference/json-rpc/state.md)
   * [Sync](reference/json-rpc/sync.md)
   * [Wallet](reference/json-rpc/wallet.md)
+  * [Web3](reference/json-rpc/web3.md)

reference/json-rpc/README.md

@@ -25,22 +25,23 @@ curl --location --request POST '<NODE_ADDRESS>' \
 
 1. In a terminal window, use Curl to request the current chain head from a public [Glif](https://glif.io) node.\
 
+- ```shell
+  curl -X POST 'https://api.node.glif.io' \
+      -H 'Content-Type: application/json' \
+      --data '{"jsonrpc":"2.0","id":1,"method":"Filecoin.ChainHead","params":[]}'
+  ```
 
-*   ```shell
-    curl -X POST 'https://api.node.glif.io' \
-        -H 'Content-Type: application/json' \
-        --data '{"jsonrpc":"2.0","id":1,"method":"Filecoin.ChainHead","params":[]}'
-    ```
+  ```shell
+  {"jsonrpc":"2.0","result":{"Cids":[{"/":"bafy2bzaceayoigaf3v5muqmknpjfkguse43jp4t2zxhpmykhqynqhkdgpgybc"},{"/":"bafy2bzacecnrtzlhn6h75gm7tozhzuw77plvdhniwzfj7wgmyuju6wn573h22"},{"/":"bafy2bzacecygiaxfsqv7ecb2gvodzh74eret3pchwe5e4j5a3mzlwasvndi6i"},{"/":"bafy2bzacebe477tdmijfse4je2g63gnnkdgzj3ftq6zbygd7toszkrsjts6uu"},{"/":"bafy2bzacedoe6hcxy2cgqzbg4p7qolbd5imbjpjnz2tj4n7o3kw2md4uv2ttq"},{"/":"bafy2bzacec7wbqvskwvolireljmufszdu5nk37yyg4qtxgnrwbyipgoenmhc6"},{"/":"bafy2bzaceahxdiauteywlbjnwj3ntr72qcbamtq3nbvjzyn5wruithpyqyxbm"}],"Blocks":[{"Miner":"f0693008","Ticket":{"VRFProof":"uLR0LHfNBAfQzyYUVBiIEXzyblPv3yPIEsJQGTpaAvO1ZriPZ7wC2IFpw7mrz1RvDQEfsgRXGxb6APTRvrPiFEAe35RFNLKC9SYb64PNcDYwGY4de5LdlHfyUv+Ovwg5"}...
+  ```
 
-    ```shell
-    {"jsonrpc":"2.0","result":{"Cids":[{"/":"bafy2bzaceayoigaf3v5muqmknpjfkguse43jp4t2zxhpmykhqynqhkdgpgybc"},{"/":"bafy2bzacecnrtzlhn6h75gm7tozhzuw77plvdhniwzfj7wgmyuju6wn573h22"},{"/":"bafy2bzacecygiaxfsqv7ecb2gvodzh74eret3pchwe5e4j5a3mzlwasvndi6i"},{"/":"bafy2bzacebe477tdmijfse4je2g63gnnkdgzj3ftq6zbygd7toszkrsjts6uu"},{"/":"bafy2bzacedoe6hcxy2cgqzbg4p7qolbd5imbjpjnz2tj4n7o3kw2md4uv2ttq"},{"/":"bafy2bzacec7wbqvskwvolireljmufszdu5nk37yyg4qtxgnrwbyipgoenmhc6"},{"/":"bafy2bzaceahxdiauteywlbjnwj3ntr72qcbamtq3nbvjzyn5wruithpyqyxbm"}],"Blocks":[{"Miner":"f0693008","Ticket":{"VRFProof":"uLR0LHfNBAfQzyYUVBiIEXzyblPv3yPIEsJQGTpaAvO1ZriPZ7wC2IFpw7mrz1RvDQEfsgRXGxb6APTRvrPiFEAe35RFNLKC9SYb64PNcDYwGY4de5LdlHfyUv+Ovwg5"}...
-    ```
+  The ChainHead endpoint doesn’t require any input parameters, so we’ve left `params` an empty array `[]`.
 
-    The ChainHead endpoint doesn’t require any input parameters, so we’ve left `params` an empty array `[]`.
-*   The above command will output a large chunk of JSON data. You can use [JSON processor JQ](https://stedolan.github.io/jq/) to _prettify_ the output:
+- The above command will output a large chunk of JSON data. You can use [JSON processor JQ](https://stedolan.github.io/jq/) to _prettify_ the output:
 
-    ```
-    ```
+  ```
+
+  ```
 
 1.  ```shell
     curl -X POST 'https://api.node.glif.io' \
@@ -72,16 +73,16 @@ curl --location --request POST '<NODE_ADDRESS>' \
 
 Each method has specific permissions that must be met before you can receive a response from a Filecoin node. Methods with the `read` permission can be called by anyone at anytime, without the need for a token. All other permissions require you to send an authentication along with you request.
 
-* `read`: Read node state, no private data.
-* `write`: Write to local store / chain, and read permissions.
-* `sign`: Use private keys stored in wallet for signing, read and write permissions.
-* `admin`: Manage permissions, read, write, and sign permissions.
+- `read`: Read node state, no private data.
+- `write`: Write to local store / chain, and read permissions.
+- `sign`: Use private keys stored in wallet for signing, read and write permissions.
+- `admin`: Manage permissions, read, write, and sign permissions.
 
 ## Authentication
 
 Each node implementation has different ways to generate and manage authentication tokens. Take a look at your node’s specific documentation:
 
-* [Lotus](https://lotus.filecoin.io)
-* [Venus](https://venus.filecoin.io)
+- [Lotus](https://lotus.filecoin.io)
+- [Venus](https://venus.filecoin.io)
 
 If you are using a node provider service like [Glif](https://glif.io) or [Chain.love](https://chain.love), take a look at your providers documentation to find out how to manage authentication tokens.

reference/json-rpc/auth.md

@@ -6,13 +6,8 @@ Perms: admin
 
 Inputs:
 
-
 ```json
-[
-  [
-    "write"
-  ]
-]
+[["write"]]
 ```
 
 Response: `"Ynl0ZSBhcnJheQ=="`
@@ -23,18 +18,12 @@ Perms: read
 
 Inputs:
 
-
 ```json
-[
-  "string value"
-]
+["string value"]
 ```
 
 Response:
 
-
 ```json
-[
-  "write"
-]
+["write"]
 ```