mirror of
https://github.com/tendermint/tendermint.git
synced 2026-09-19 14:34:17 +00:00
docs: updates to various sections (#5285)
## Description Updates to various sections of docs. Fix docs deployment Closes: #XXX
This commit is contained in:
+33
-40
@@ -520,20 +520,25 @@ paths:
|
||||
schema:
|
||||
$ref: "#/components/schemas/ErrorResponse"
|
||||
/dial_seeds:
|
||||
post:
|
||||
get:
|
||||
summary: Dial Seeds (Unsafe)
|
||||
operationId: dial_seeds
|
||||
tags:
|
||||
- Unsafe
|
||||
description: |
|
||||
Dial a peer, this route in under unsafe, and has to manually enabled to use
|
||||
requestBody:
|
||||
description: string of possible peers
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/dialSeedsPost"
|
||||
|
||||
**Example:** curl 'localhost:26657/dial_seeds?seeds=\["f9baeaa15fedf5e1ef7448dd60f46c01f1a9e9c4@1.2.3.4:26656","0491d373a8e0fcf1023aaf18c51d6a1d0d4f31bd@5.6.7.8:26656"\]'
|
||||
parameters:
|
||||
- in: query
|
||||
name: peers
|
||||
description: list of seed nodes to dial
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
example:
|
||||
["f9baeaa15fedf5e1ef7448dd60f46c01f1a9e9c4@1.2.3.4:26656"]
|
||||
responses:
|
||||
"200":
|
||||
description: Dialing seeds in progress. See /net_info for details
|
||||
@@ -548,20 +553,31 @@ paths:
|
||||
schema:
|
||||
$ref: "#/components/schemas/ErrorResponse"
|
||||
/dial_peers:
|
||||
post:
|
||||
get:
|
||||
summary: Add Peers/Persistent Peers (unsafe)
|
||||
operationId: dial_peers
|
||||
tags:
|
||||
- Unsafe
|
||||
description: |
|
||||
Set a persistent peer, this route in under unsafe, and has to manually enabled to use
|
||||
requestBody:
|
||||
description: string of possible peers, bool argument if they should be added as persistent
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/dialPeersPost"
|
||||
Set a persistent peer, this route in under unsafe, and has to manually enabled to use.
|
||||
|
||||
**Example:** curl 'localhost:26657/dial_peers?peers=\["f9baeaa15fedf5e1ef7448dd60f46c01f1a9e9c4@1.2.3.4:26656","0491d373a8e0fcf1023aaf18c51d6a1d0d4f31bd@5.6.7.8:26656"\]&persistent=false'
|
||||
parameters:
|
||||
- in: query
|
||||
name: persistent
|
||||
description: Have the peers you are dialing be persistent
|
||||
schema:
|
||||
type: boolean
|
||||
example: true
|
||||
- in: query
|
||||
name: peers
|
||||
description: array of peers to dial
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
example:
|
||||
["f9baeaa15fedf5e1ef7448dd60f46c01f1a9e9c4@1.2.3.4:26656"]
|
||||
responses:
|
||||
"200":
|
||||
description: Dialing seeds in progress. See /net_info for details
|
||||
@@ -2649,29 +2665,6 @@ components:
|
||||
type: string
|
||||
example: ""
|
||||
|
||||
dialPeersPost:
|
||||
type: object
|
||||
properties:
|
||||
Persistent:
|
||||
type: boolean
|
||||
example: false
|
||||
Peers:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
example:
|
||||
["6f172048b821e3b1ab98ffb0973ba737966eecf8@192.168.1.2:26656"]
|
||||
|
||||
dialSeedsPost:
|
||||
type: object
|
||||
properties:
|
||||
Peers:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
example:
|
||||
["6f172048b821e3b1ab98ffb0973ba737966eecf8@192.168.1.2:26656"]
|
||||
|
||||
dialResp:
|
||||
type: object
|
||||
properties:
|
||||
|
||||
Reference in New Issue
Block a user