From f3f03b9055310d1698fe57c2c02be317be9baf20 Mon Sep 17 00:00:00 2001 From: Tim Gross Date: Fri, 7 Aug 2020 13:41:33 -0400 Subject: [PATCH] docs: API docs update for volume detach --- website/pages/api-docs/volumes.mdx | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/website/pages/api-docs/volumes.mdx b/website/pages/api-docs/volumes.mdx index 5c1e78411544..60cdb01d2aeb 100644 --- a/website/pages/api-docs/volumes.mdx +++ b/website/pages/api-docs/volumes.mdx @@ -297,8 +297,8 @@ $ curl \ ## Delete Volume -This endpoint deregisters an external volume with Nomad. It is an -error to deregister a volume that is in use. +This endpoint deregisters an external volume with Nomad or detaches the volume +from a node. It is an error to deregister or detach a volume that is in use. | Method | Path | Produces | | ------- | ---------------------------- | ------------------ | @@ -323,6 +323,12 @@ The table below shows this endpoint's support for running allocations. This does not detach the volume from client nodes. This is specified as a query string parameter. +- `detach` `(bool: false)`- Detach the volume from the node given by the `node` + parameter, rather than deregister it. + +- `node` `(string: "")`- The node to detach the volume from. This parameter is + required if the `detach` parameter is `true`. + ### Sample Request ```shell-session