diff --git a/website/docs/references/http_api_reference.mdx b/website/docs/references/http_api_reference.mdx index 820d343..1218f5e 100644 --- a/website/docs/references/http_api_reference.mdx +++ b/website/docs/references/http_api_reference.mdx @@ -2641,7 +2641,7 @@ A `500` HTTP status code indicates an error condition. The response includes a J **POST** `/admin/node/current` -Set a node role. +Sets role for a node. ### Request @@ -2662,8 +2662,7 @@ curl --request POST \ '{ "role" : "follower", "name" : "following", - "address" : "0.0.0.0", - "port" : 23851 + "address" : "0.0.0.0:23851" }' ``` @@ -2677,7 +2676,6 @@ curl --request POST \ - Parameter settings for setting a node to `follower` or `learner`: - "name" Required : Name of the node in the cluster. - "address" Required : Peer server address of the leader in the cluster. - - "port" Required : Peer server port of the leader in the cluster. ### Response @@ -2726,7 +2724,7 @@ A `500` HTTP status code indicates an error condition. The response includes a J **GET** `/admin/variables` -Show all node variables in admin mode. +Shows all node variables in admin mode. ### Request @@ -2748,12 +2746,7 @@ None. ### Response - - +#### Status code 200 The response includes a JSON object like the following: @@ -2767,14 +2760,13 @@ The response includes a JSON object like the following: - `"error_code"`: `integer` `0`: The operation succeeds. - --- ## Admin show node configs **GET** `/admin/configs` -Show all node configs in admin mode. +Shows all node configs in admin mode. ### Request @@ -2836,8 +2828,6 @@ The response includes a JSON object like the following: } ``` - - --- ## Admin show node variable @@ -2913,7 +2903,7 @@ The response includes a JSON object like the following: **GET** `/admin/node/current` -Get information about the currently connected node. +Gets information about the currently connected node. ### Request @@ -2934,12 +2924,8 @@ curl --request GET \ None. ### Response - - + +#### Status code 200 The response includes a JSON object like the following: @@ -2955,16 +2941,13 @@ The response includes a JSON object like the following: - `"node_role": string` The role of querying node. - - - --- ## Admin show node **GET** `/admin/node/{node_name}` -Get information about a node in the cluster. +Gets information about a node in the cluster. ### Request @@ -3033,7 +3016,7 @@ A `500` HTTP status code indicates an error condition. The response includes a J **GET** `/admin/nodes` -List all nodes in the cluster. +Lists all nodes in the cluster. ### Request @@ -3055,12 +3038,7 @@ None. ### Response - - +#### Status code 200 The response includes a JSON object like the following: @@ -3080,9 +3058,6 @@ The response includes a JSON object like the following: - `"nodes" : array` : Each element is in `[nodename, noderole]` format. - - - ---