docs follow-ups for networks "dangling" filter

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2019-02-28 17:39:57 +01:00
parent 8df160dde7
commit ca91918dd4
No known key found for this signature in database
GPG key ID: 76698F39D527CE8C
3 changed files with 11 additions and 3 deletions

View file

@ -8088,6 +8088,10 @@ paths:
description: |
JSON encoded value of the filters (a `map[string][]string`) to process on the networks list. Available filters:
- `dangling=<boolean>` When set to `true` (or `1`), returns all
networks that are not in use by a container. When set to `false`
(or `0`), only networks that are in use by one or more
containers are returned.
- `driver=<driver-name>` Matches a network's driver.
- `id=<network-id>` Matches all or part of a network ID.
- `label=<key>` or `label=<key>=<value>` of a network label.

View file

@ -112,13 +112,13 @@ type ConfigReference struct {
}
var acceptedFilters = map[string]bool{
"dangling": true,
"driver": true,
"type": true,
"name": true,
"id": true,
"label": true,
"name": true,
"scope": true,
"dangling": true,
"type": true,
}
// ValidateFilters validates the list of filter args with the available filters.

View file

@ -35,6 +35,10 @@ keywords: "API, Docker, rcli, REST, documentation"
* `POST /services/{id}/update` now includes `Runtime` as an option in `ContainerSpec.Configs`
* `GET /tasks` now returns `Sysctls` as part of the `ContainerSpec`.
* `GET /tasks/{id}` now returns `Sysctls` as part of the `ContainerSpec`.
* `GET /networks` now supports a `dangling` filter type. When set to `true` (or
`1`), the endpoint returns all networks that are not in use by a container. When
set to `false` (or `0`), only networks that are in use by one or more containers
are returned.
* `GET /nodes` now supports a filter type `node.label` filter to filter nodes based
on the node.label. The format of the label filter is `node.label=<key>`/`node.label=<key>=<value>`
to return those with the specified labels, or `node.label!=<key>`/`node.label!=<key>=<value>`