Skip to content

docs: add return info for update and delete acl-token apis #4584

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mkeeler merged 2 commits into from
Oct 24, 2018
Merged

docs: add return info for update and delete acl-token apis #4584

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c072f8d
docs: add return info for update and delete apis
rajanadar Aug 26, 2018
8c303d9
consistent docs
rajanadar Aug 26, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions website/source/api/acl.html.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,14 @@ $ curl \
https://consul.rocks/v1/acl/update
```

### Sample Response

```json
{
"ID": "adf4238a-882b-9ddc-4a9d-5b6758e4159e"
}
```

## Delete ACL Token

This endpoint deletes an ACL token with the given ID.
Expand All @@ -166,6 +174,8 @@ This endpoint deletes an ACL token with the given ID.
| ------ | ---------------------------- | -------------------------- |
| `PUT` | `/acl/destroy/:uuid` | `application/json` |

Even though the return type is application/json, the value is either true or false, indicating whether the delete succeeded.

The table below shows this endpoint's support for
[blocking queries](/api/index.html#blocking-queries),
[consistency modes](/api/index.html#consistency-modes), and
Expand All @@ -188,6 +198,13 @@ $ curl \
https://consul.rocks/v1/acl/destroy/8f246b77-f3e1-ff88-5b48-8ec93abf3e05
```

### Sample Response

```json
true
```


## Read ACL Token

This endpoint reads an ACL token with the given ID.
Expand Down