From 242cef5ac8c4535e0edb1e13d142744cb6b7c1e9 Mon Sep 17 00:00:00 2001 From: James Phillips Date: Tue, 7 Feb 2017 19:02:18 -0800 Subject: [PATCH] Removes broken WriteRequest ACL reference for catalog endpoints. Fixes #1034. --- .../docs/agent/http/catalog.html.markdown | 40 +++++++++---------- 1 file changed, 18 insertions(+), 22 deletions(-) diff --git a/website/source/docs/agent/http/catalog.html.markdown b/website/source/docs/agent/http/catalog.html.markdown index bffc4b8884..1ef062cdfe 100644 --- a/website/source/docs/agent/http/catalog.html.markdown +++ b/website/source/docs/agent/http/catalog.html.markdown @@ -106,16 +106,8 @@ an array of `Check` objects. It is important to note that `Check` does not have to be provided with `Service` and vice versa. A catalog entry can have either, neither, or both. -An optional ACL token may be provided to perform the registration by including a -`WriteRequest` block in the query payload, like this: - -```javascript -{ - "WriteRequest": { - "Token": "foo" - } -} -``` +The endpoint supports the use of ACL tokens using the ?token= query parameter +or the `X-Consul-Token` request header. If the API call succeeds, a 200 status code is returned. @@ -159,16 +151,8 @@ all associated services and checks are deleted. If `CheckID` is provided, only that check is removed. If `ServiceID` is provided, the service and its associated health check (if any) are removed. -An optional ACL token may be provided to perform the deregister action by adding -a `WriteRequest` block to the payload, like this: - -```javascript -{ - "WriteRequest": { - "Token": "foo" - } -} -``` +The endpoint supports the use of ACL tokens using the ?token= query parameter +or the `X-Consul-Token` request header. If the API call succeeds a 200 status code is returned. @@ -240,6 +224,9 @@ It returns a JSON body like this: This endpoint supports blocking queries and all consistency modes. +The endpoint supports the use of ACL tokens using the ?token= query parameter +or the `X-Consul-Token` request header. + ### /v1/catalog/services This endpoint is hit with a `GET` and returns the services registered @@ -269,6 +256,9 @@ tags for a given service. This endpoint supports blocking queries and all consistency modes. +The endpoint supports the use of ACL tokens using the ?token= query parameter +or the `X-Consul-Token` request header. + ### /v1/catalog/service/\ This endpoint is hit with a `GET` and returns the nodes providing a service @@ -318,8 +308,6 @@ It returns a JSON body like this: ] ``` -This endpoint supports blocking queries and all consistency modes. - The returned fields are as follows: - `Address`: IP address of the Consul node on which the service is registered @@ -335,6 +323,11 @@ The returned fields are as follows: - `ServicePort`: Port number of the service - `ServiceTags`: List of tags for the service +This endpoint supports blocking queries and all consistency modes. + +The endpoint supports the use of ACL tokens using the ?token= query parameter +or the `X-Consul-Token` request header. + ### /v1/catalog/node/\ This endpoint is hit with a `GET` and returns the node's registered services. @@ -378,3 +371,6 @@ It returns a JSON body like this: ``` This endpoint supports blocking queries and all consistency modes. + +The endpoint supports the use of ACL tokens using the ?token= query parameter +or the `X-Consul-Token` request header.