docs: clarify prefix API param requirements

This commit is contained in:
Luiz Aoqui 2019-10-08 18:11:56 -04:00
parent b9ef978641
commit 521c0ad2a5
No known key found for this signature in database
GPG key ID: F1178C891120DF5E
6 changed files with 23 additions and 11 deletions

View file

@ -31,7 +31,9 @@ The table below shows this endpoint's support for
### Parameters
- `prefix` `(string: "")` - Specifies a string to filter ACL policies based on
a name prefix. This is specified as a query string parameter.
a name prefix. Because the value is decoded to bytes, the prefix must have an
even number of hexadecimal characters (0-9a-f). This is specified as a query
string parameter.
### Sample Request

View file

@ -73,7 +73,9 @@ The table below shows this endpoint's support for
### Parameters
- `prefix` `(string: "")` - Specifies a string to filter ACL tokens based on an
accessor ID prefix. This is specified as a query string parameter.
accessor ID prefix. Because the value is decoded to bytes, the prefix must
have an even number of hexadecimal characters (0-9a-f). This is specified as
a query string parameter.
### Sample Request

View file

@ -28,8 +28,10 @@ The table below shows this endpoint's support for
### Parameters
- `prefix` `(string: "")`- Specifies a string to filter allocations on based on
an index prefix. This is specified as a query string parameter.
- `prefix` `(string: "")`- Specifies a string to filter allocations based on an
ID prefix. Because the value is decoded to bytes, the prefix must have an
even number of hexadecimal characters (0-9a-f). This is specified as a query
string parameter.
### Sample Request

View file

@ -29,7 +29,9 @@ The table below shows this endpoint's support for
### Parameters
- `prefix` `(string: "")`- Specifies a string to filter deployments based on
an index prefix. This is specified as a query string parameter.
an ID prefix. Because the value is decoded to bytes, the prefix must have an
even number of hexadecimal characters (0-9a-f) .This is specified as a query
string parameter.
### Sample Request

View file

@ -28,8 +28,10 @@ The table below shows this endpoint's support for
### Parameters
- `prefix` `(string: "")`- Specifies a string to filter evaluations on based on
an index prefix. This is specified as a query string parameter.
- `prefix` `(string: "")`- Specifies a string to filter evaluations based on an
ID prefix. Because the value is decoded to bytes, the prefix must have an
even number of hexadecimal characters (0-9a-f). This is specified as a query
string parameter.
### Sample Request
@ -40,7 +42,7 @@ $ curl \
```text
$ curl \
https://localhost:4646/v1/evaluations?prefix=25ba81c
https://localhost:4646/v1/evaluations?prefix=25ba81
```
### Sample Response

View file

@ -28,8 +28,10 @@ The table below shows this endpoint's support for
### Parameters
- `prefix` `(string: "")`- Specifies a string to filter nodes on based on an
index prefix. This is specified as a query string parameter.
- `prefix` `(string: "")`- Specifies a string to filter nodes based on an ID
prefix. Because the value is decoded to bytes, the prefix must have an even
number of hexadecimal characters (0-9a-f). This is specified as a query
string parameter.
### Sample Request
@ -40,7 +42,7 @@ $ curl \
```text
$ curl \
http://localhost:4646/v1/nodes?prefix=prod
http://localhost:4646/v1/nodes?prefix=f7476465
```
### Sample Response