From e7629564ef20bb3a66f47ff268be3511fbb5c4c7 Mon Sep 17 00:00:00 2001 From: Raja Nadar Date: Wed, 24 Oct 2018 08:11:51 -0700 Subject: [PATCH] docs: add return info for update and delete acl-token apis (#4584) * Update Token API returns the ID of the token updated. * Delete Token API returns a raw text which is true for successful deletions --- website/source/api/acl.html.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/website/source/api/acl.html.md b/website/source/api/acl.html.md index bcd019aff3..29f38760ce 100644 --- a/website/source/api/acl.html.md +++ b/website/source/api/acl.html.md @@ -161,6 +161,14 @@ $ curl \ http://127.0.0.1:8500/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. @@ -169,6 +177,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), @@ -192,6 +202,13 @@ $ curl \ http://127.0.0.1:8500/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.