Skip to content

Commit

Permalink
docs: document hashicorp#9055
Browse files Browse the repository at this point in the history
  • Loading branch information
schmichael authored and fredrikhgrelland committed Oct 22, 2020
1 parent 119527a commit 84697df
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ IMPROVEMENTS:
* core: Improved job deregistration error logging. [[GH-8745](https://github.com/hashicorp/nomad/issues/8745)]
* api: Added support for cancellation contexts to HTTP API. [[GH-8836](https://github.com/hashicorp/nomad/issues/8836)]
* api: Job Register API now permits non-zero initial Version to accommodate multi-region deployments. [[GH-9071](https://github.com/hashicorp/nomad/issues/9071)]
* api: Added ?resources=true query parameter to /v1/nodes and /v1/allocations to include resource allocations in listings. [[GH-9055](https://github.com/hashicorp/nomad/issues/9055)]
* api: Added ?task_states=false query parameter to /v1/allocations to remove TaskStates from listings. Defaults to being included as before. [[GH-9055](https://github.com/hashicorp/nomad/issues/9055)]
* cli: Added `scale` and `scaling-events` subcommands to the `job` command. [[GH-9023](https://github.com/hashicorp/nomad/pull/9023)]
* cli: Added `scaling` command for interaction with the scaling API endpoint. [[GH-9025](https://github.com/hashicorp/nomad/pull/9025)]
* client: Use ec2 CPU perf data from AWS API [[GH-7830](https://github.com/hashicorp/nomad/issues/7830)]
Expand Down
9 changes: 9 additions & 0 deletions website/pages/api-docs/allocations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,15 @@ The table below shows this endpoint's support for
- `namespace` `(string: "default")` - Specifies the namespace to search. Specifying
`*` would return all allocations across all the authorized namespaces.

- `resources` `(bool: false)` - Specifies whether or not to include the
`AllocatedResources` field in the response.

- `task_states` `(bool: true)` - Specifies whether or not to include the
`TaskStates` field in the response. TaskStates are included by default but
can represent a large percentage of the overall response size. Clusters with
a large number of allocations may set `task_states=false` to significantly
reduce the size of the response.

### Sample Request

```shell-session
Expand Down
3 changes: 3 additions & 0 deletions website/pages/api-docs/nodes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ The table below shows this endpoint's support for
number of hexadecimal characters (0-9a-f). This is specified as a query
string parameter.

- `resources` `(bool: false)` - Specifies whether or not to include the
`NodeResources` and `ReservedResources` fields in the response.

### Sample Request

```shell-session
Expand Down

0 comments on commit 84697df

Please sign in to comment.