status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

website: mention node name for "agent/force-leave" HTTP endpoint (#4542) 

* Adjust documentation for agent/force-leave endpoint

A node must be specified when calling agent/force-leave.
See:
 - https://github.com/hashicorp/consul/blob/master/agent/http_oss.go#L25
 - https://github.com/hashicorp/consul/blob/master/agent/agent_endpoint.go#L323
 - https://github.com/hashicorp/consul/blob/master/agent/agent.go#L1442

However, the documentation does not specify it.
Note that Consul returns "301 Moved Permanently v1/agent/force-leave/" when sending PUT request on "v1/agent/force-leave".

* Switch from node id to node name
This commit is contained in:
Yoann Fouquet 2018-10-24 17:20:05 +02:00 committed by Hans Hasselberg
parent e7629564ef
commit a7f83b62f3
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
website/source/api/agent.html.md
View File

@ -488,7 +488,7 @@ state allows its old entries to be removed.
| Method | Path | Produces | | Method | Path | Produces |
| ------ | ---------------------------- | -------------------------- | | ------ | ---------------------------- | -------------------------- |
| `PUT` | `/agent/force-leave` | `application/json` | | `PUT` | `/agent/force-leave/:node` | `application/json` |
The table below shows this endpoint's support for The table below shows this endpoint's support for
[blocking queries](/api/index.html#blocking-queries), [blocking queries](/api/index.html#blocking-queries),
@ -500,12 +500,16 @@ The table below shows this endpoint's support for
| ---------------- | ----------------- | ------------- | ------------- | | ---------------- | ----------------- | ------------- | ------------- |
| `NO` | `none` | `none` | `agent:write` | | `NO` | `none` | `none` | `agent:write` |
### Parameters
- `node` `(string: <required>)` - Specifies the name of the node to be forced into `left` state. This is specified as part of the URL.
### Sample Request ### Sample Request
```text ```text
$ curl \ $ curl \
--request PUT \ --request PUT \
http://127.0.0.1:8500/v1/agent/force-leave http://127.0.0.1:8500/v1/agent/force-leave/agent-one
``` ```
## Update ACL Tokens ## Update ACL Tokens