Merge pull request #5666 from hashicorp/docs-querystring
docs: Change querystring -> query string
This commit is contained in:
commit
eac0e679aa
|
@ -29,7 +29,7 @@ The table below shows this endpoint's support for
|
||||||
### Parameters
|
### Parameters
|
||||||
|
|
||||||
- `prefix` `(string: "")`- Specifies a string to filter allocations on based on
|
- `prefix` `(string: "")`- Specifies a string to filter allocations on based on
|
||||||
an index prefix. This is specified as a querystring parameter.
|
an index prefix. This is specified as a query string parameter.
|
||||||
|
|
||||||
### Sample Request
|
### Sample Request
|
||||||
|
|
||||||
|
|
|
@ -29,7 +29,7 @@ The table below shows this endpoint's support for
|
||||||
### Parameters
|
### Parameters
|
||||||
|
|
||||||
- `prefix` `(string: "")`- Specifies a string to filter deployments based on
|
- `prefix` `(string: "")`- Specifies a string to filter deployments based on
|
||||||
an index prefix. This is specified as a querystring parameter.
|
an index prefix. This is specified as a query string parameter.
|
||||||
|
|
||||||
### Sample Request
|
### Sample Request
|
||||||
|
|
||||||
|
|
|
@ -29,7 +29,7 @@ The table below shows this endpoint's support for
|
||||||
### Parameters
|
### Parameters
|
||||||
|
|
||||||
- `prefix` `(string: "")`- Specifies a string to filter evaluations on based on
|
- `prefix` `(string: "")`- Specifies a string to filter evaluations on based on
|
||||||
an index prefix. This is specified as a querystring parameter.
|
an index prefix. This is specified as a query string parameter.
|
||||||
|
|
||||||
### Sample Request
|
### Sample Request
|
||||||
|
|
||||||
|
|
|
@ -29,7 +29,7 @@ The table below shows this endpoint's support for
|
||||||
### Parameters
|
### Parameters
|
||||||
|
|
||||||
- `prefix` `(string: "")` - Specifies a string to filter jobs on based on
|
- `prefix` `(string: "")` - Specifies a string to filter jobs on based on
|
||||||
an index prefix. This is specified as a querystring parameter.
|
an index prefix. This is specified as a query string parameter.
|
||||||
|
|
||||||
### Sample Request
|
### Sample Request
|
||||||
|
|
||||||
|
|
|
@ -26,7 +26,7 @@ The table below shows this endpoint's support for
|
||||||
|
|
||||||
- `format` `(string: "")` - Specifies the metrics format to be other than the
|
- `format` `(string: "")` - Specifies the metrics format to be other than the
|
||||||
JSON default. Currently, only `prometheus` is supported as an alternative
|
JSON default. Currently, only `prometheus` is supported as an alternative
|
||||||
format. This is specified as a querystring parameter.
|
format. This is specified as a query string parameter.
|
||||||
|
|
||||||
### Sample Request
|
### Sample Request
|
||||||
|
|
||||||
|
|
|
@ -32,7 +32,7 @@ The table below shows this endpoint's support for
|
||||||
### Parameters
|
### Parameters
|
||||||
|
|
||||||
- `prefix` `(string: "")`- Specifies a string to filter namespaces on based on
|
- `prefix` `(string: "")`- Specifies a string to filter namespaces on based on
|
||||||
an index prefix. This is specified as a querystring parameter.
|
an index prefix. This is specified as a query string parameter.
|
||||||
|
|
||||||
### Sample Request
|
### Sample Request
|
||||||
|
|
||||||
|
|
|
@ -29,7 +29,7 @@ The table below shows this endpoint's support for
|
||||||
### Parameters
|
### Parameters
|
||||||
|
|
||||||
- `prefix` `(string: "")`- Specifies a string to filter nodes on based on an
|
- `prefix` `(string: "")`- Specifies a string to filter nodes on based on an
|
||||||
index prefix. This is specified as a querystring parameter.
|
index prefix. This is specified as a query string parameter.
|
||||||
|
|
||||||
### Sample Request
|
### Sample Request
|
||||||
|
|
||||||
|
|
|
@ -39,7 +39,7 @@ The table below shows this endpoint's support for
|
||||||
### Parameters
|
### Parameters
|
||||||
|
|
||||||
- `stale` - Specifies if the cluster should respond without an active leader.
|
- `stale` - Specifies if the cluster should respond without an active leader.
|
||||||
This is specified as a querystring parameter.
|
This is specified as a query string parameter.
|
||||||
|
|
||||||
### Sample Request
|
### Sample Request
|
||||||
|
|
||||||
|
|
|
@ -32,7 +32,7 @@ The table below shows this endpoint's support for
|
||||||
### Parameters
|
### Parameters
|
||||||
|
|
||||||
- `prefix` `(string: "")`- Specifies a string to filter quota specifications on
|
- `prefix` `(string: "")`- Specifies a string to filter quota specifications on
|
||||||
based on an index prefix. This is specified as a querystring parameter.
|
based on an index prefix. This is specified as a query string parameter.
|
||||||
|
|
||||||
### Sample Request
|
### Sample Request
|
||||||
|
|
||||||
|
@ -228,7 +228,7 @@ The table below shows this endpoint's support for
|
||||||
### Parameters
|
### Parameters
|
||||||
|
|
||||||
- `prefix` `(string: "")`- Specifies a string to filter quota specifications on
|
- `prefix` `(string: "")`- Specifies a string to filter quota specifications on
|
||||||
based on an index prefix. This is specified as a querystring parameter.
|
based on an index prefix. This is specified as a query string parameter.
|
||||||
|
|
||||||
### Sample Request
|
### Sample Request
|
||||||
|
|
||||||
|
|
|
@ -23,19 +23,19 @@ This page lists all known jobs in a paginated, searchable, and sortable table.
|
||||||
### Parameters
|
### Parameters
|
||||||
|
|
||||||
- `namespace` `(string: "")` - Specifies the namespace all jobs should be a member
|
- `namespace` `(string: "")` - Specifies the namespace all jobs should be a member
|
||||||
of. This is specified as a querystring parameter. Namespaces are an enterprise feature.
|
of. This is specified as a query string parameter. Namespaces are an enterprise feature.
|
||||||
|
|
||||||
- `sort` `(string: "")` - Specifies the property the list of jobs should be sorted by.
|
- `sort` `(string: "")` - Specifies the property the list of jobs should be sorted by.
|
||||||
This is specified as a querystring parameter.
|
This is specified as a query string parameter.
|
||||||
|
|
||||||
- `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending
|
- `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending
|
||||||
or ascending. This is specified as a querystring parameter.
|
or ascending. This is specified as a query string parameter.
|
||||||
|
|
||||||
- `search` `(string: "")` - Specifies a regular expression uses to filter the list of
|
- `search` `(string: "")` - Specifies a regular expression uses to filter the list of
|
||||||
visible jobs. This is specified as a querystring parameter.
|
visible jobs. This is specified as a query string parameter.
|
||||||
|
|
||||||
- `page` `(int: 0)` - Specifies the page in the jobs list that should be visible. This
|
- `page` `(int: 0)` - Specifies the page in the jobs list that should be visible. This
|
||||||
is specified as a querystring parameter.
|
is specified as a query string parameter.
|
||||||
|
|
||||||
|
|
||||||
## Job Detail
|
## Job Detail
|
||||||
|
@ -74,13 +74,13 @@ based on the type of job.
|
||||||
### Parameters
|
### Parameters
|
||||||
|
|
||||||
- `sort` `(string: "")` - Specifies the property the list of task groups should be
|
- `sort` `(string: "")` - Specifies the property the list of task groups should be
|
||||||
sorted by. This is specified as a querystring parameter.
|
sorted by. This is specified as a query string parameter.
|
||||||
|
|
||||||
- `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending
|
- `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending
|
||||||
or ascending. This is specified as a querystring parameter.
|
or ascending. This is specified as a query string parameter.
|
||||||
|
|
||||||
- `page` `(int: 0)` - Specifies the page in the task groups list that should be visible. This
|
- `page` `(int: 0)` - Specifies the page in the task groups list that should be visible. This
|
||||||
is specified as a querystring parameter.
|
is specified as a query string parameter.
|
||||||
|
|
||||||
|
|
||||||
### Job Definition
|
### Job Definition
|
||||||
|
@ -133,16 +133,16 @@ allocations.
|
||||||
### Parameters
|
### Parameters
|
||||||
|
|
||||||
- `sort` `(string: "")` - Specifies the property the list of allocations should be sorted by.
|
- `sort` `(string: "")` - Specifies the property the list of allocations should be sorted by.
|
||||||
This is specified as a querystring parameter.
|
This is specified as a query string parameter.
|
||||||
|
|
||||||
- `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending
|
- `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending
|
||||||
or ascending. This is specified as a querystring parameter.
|
or ascending. This is specified as a query string parameter.
|
||||||
|
|
||||||
- `search` `(string: "")` - Specifies a regular expression uses to filter the list of
|
- `search` `(string: "")` - Specifies a regular expression uses to filter the list of
|
||||||
visible allocations. This is specified as a querystring parameter.
|
visible allocations. This is specified as a query string parameter.
|
||||||
|
|
||||||
- `page` `(int: 0)` - Specifies the page in the allocations list that should be visible. This
|
- `page` `(int: 0)` - Specifies the page in the allocations list that should be visible. This
|
||||||
is specified as a querystring parameter.
|
is specified as a query string parameter.
|
||||||
|
|
||||||
|
|
||||||
## Allocation Detail
|
## Allocation Detail
|
||||||
|
@ -160,10 +160,10 @@ description of the event.
|
||||||
### Parameters
|
### Parameters
|
||||||
|
|
||||||
- `sort` `(string: "")` - Specifies the property the list of tasks should be sorted by.
|
- `sort` `(string: "")` - Specifies the property the list of tasks should be sorted by.
|
||||||
This is specified as a querystring parameter.
|
This is specified as a query string parameter.
|
||||||
|
|
||||||
- `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending
|
- `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending
|
||||||
or ascending. This is specified as a querystring parameter.
|
or ascending. This is specified as a query string parameter.
|
||||||
|
|
||||||
|
|
||||||
## Task Detail
|
## Task Detail
|
||||||
|
@ -199,16 +199,16 @@ table.
|
||||||
### Parameters
|
### Parameters
|
||||||
|
|
||||||
- `sort` `(string: "")` - Specifies the property the list of client nodes should be sorted by.
|
- `sort` `(string: "")` - Specifies the property the list of client nodes should be sorted by.
|
||||||
This is specified as a querystring parameter.
|
This is specified as a query string parameter.
|
||||||
|
|
||||||
- `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending
|
- `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending
|
||||||
or ascending. This is specified as a querystring parameter.
|
or ascending. This is specified as a query string parameter.
|
||||||
|
|
||||||
- `search` `(string: "")` - Specifies a regular expression uses to filter the list of
|
- `search` `(string: "")` - Specifies a regular expression uses to filter the list of
|
||||||
visible client nodes. This is specified as a querystring parameter.
|
visible client nodes. This is specified as a query string parameter.
|
||||||
|
|
||||||
- `page` `(int: 0)` - Specifies the page in the client nodes list that should be visible. This
|
- `page` `(int: 0)` - Specifies the page in the client nodes list that should be visible. This
|
||||||
is specified as a querystring parameter.
|
is specified as a query string parameter.
|
||||||
|
|
||||||
|
|
||||||
## Node Detail
|
## Node Detail
|
||||||
|
@ -223,16 +223,16 @@ address, port, datacenter, allocations, and attributes.
|
||||||
### Parameters
|
### Parameters
|
||||||
|
|
||||||
- `sort` `(string: "")` - Specifies the property the list of allocations should be sorted by.
|
- `sort` `(string: "")` - Specifies the property the list of allocations should be sorted by.
|
||||||
This is specified as a querystring parameter.
|
This is specified as a query string parameter.
|
||||||
|
|
||||||
- `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending
|
- `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending
|
||||||
or ascending. This is specified as a querystring parameter.
|
or ascending. This is specified as a query string parameter.
|
||||||
|
|
||||||
- `search` `(string: "")` - Specifies a regular expression uses to filter the list of
|
- `search` `(string: "")` - Specifies a regular expression uses to filter the list of
|
||||||
visible allocations. This is specified as a querystring parameter.
|
visible allocations. This is specified as a query string parameter.
|
||||||
|
|
||||||
- `page` `(int: 0)` - Specifies the page in the allocations list that should be visible. This
|
- `page` `(int: 0)` - Specifies the page in the allocations list that should be visible. This
|
||||||
is specified as a querystring parameter.
|
is specified as a query string parameter.
|
||||||
|
|
||||||
|
|
||||||
## Servers List
|
## Servers List
|
||||||
|
@ -248,13 +248,13 @@ the leader.
|
||||||
### Parameters
|
### Parameters
|
||||||
|
|
||||||
- `sort` `(string: "")` - Specifies the property the list of server agents should be sorted by.
|
- `sort` `(string: "")` - Specifies the property the list of server agents should be sorted by.
|
||||||
This is specified as a querystring parameter.
|
This is specified as a query string parameter.
|
||||||
|
|
||||||
- `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending
|
- `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending
|
||||||
or ascending. This is specified as a querystring parameter.
|
or ascending. This is specified as a query string parameter.
|
||||||
|
|
||||||
- `page` `(int: 0)` - Specifies the page in the server agents list that should be visible. This
|
- `page` `(int: 0)` - Specifies the page in the server agents list that should be visible. This
|
||||||
is specified as a querystring parameter.
|
is specified as a query string parameter.
|
||||||
|
|
||||||
|
|
||||||
## Server Detail
|
## Server Detail
|
||||||
|
|
Loading…
Reference in New Issue