luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

Removes broken WriteRequest ACL reference for catalog endpoints. 

Fixes #1034.
This commit is contained in:
James Phillips 2017-02-07 19:02:18 -08:00 committed by GitHub
parent 2a2c3bbbda
commit 723391b22d
1 changed files with 18 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
website/source/docs/agent/http/catalog.html.markdown
View File

@ -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.
### <a name="catalog_services"></a> /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.
### <a name="catalog_service"></a> /v1/catalog/service/\<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.
### <a name="catalog_node"></a> /v1/catalog/node/\<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.