Skip to content

Commit

Permalink
Fix docs on API for volume detaching (#9002)
Browse files Browse the repository at this point in the history
`nomad volume detach volume-id 00000000-0000-0000-0000-000000000000` produces an API call containing the UUID as part of the query string. This is the only way the API accepts the request correctly - if you pass it in the payload you get `detach requires node ID`
  • Loading branch information
josemaia authored and roaks3 committed Oct 7, 2020
1 parent 6a940b9 commit d0677aa
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions website/pages/api-docs/volumes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -360,12 +360,12 @@ The table below shows this endpoint's support for
path.

- `node` `(string: <required>)`- The node to detach the volume from.
This is specified as a query string parameter.

### Sample Request

```shell-session
$ curl \
--request DELETE \
--data @payload.json \
https://localhost:4646/v1/volume/csi/volume-id/detach
https://localhost:4646/v1/volume/csi/volume-id/detach?node=00000000-0000-0000-0000-000000000000
```

0 comments on commit d0677aa

Please sign in to comment.