From 7afef854ed14bba2cc07d53e6f21455056053a35 Mon Sep 17 00:00:00 2001 From: Nikolay Edigaryev Date: Wed, 23 Sep 2020 12:22:10 +0300 Subject: [PATCH] api: clarify "v" option behavior in the container remove endpoint MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Current description of the "v" option doesn't explain what happens to the volumes that are still in use by other containers. Turns out that the only volumes that are removed are unnamed ones[1]. Perhaps a good way of clarifying this behavior would be adapting the description from "docker rm --help". As for the docs/api/v1.*.yaml changes — they seem to be applicable, since the origin of this behavior dates way back to the 2016 or v1.11[2]. [1]: https://github.com/moby/moby/blob/a24a71c50f34d53710cccaa4d5e5f62169c5e1dc/daemon/mounts.go#L34-L38 [2]: https://github.com/moby/moby/commit/dd7d1c8a02d8693aa4f381f82c5bbdcad9a5ff58 Signed-off-by: Nikolay Edigaryev --- api/swagger.yaml | 2 +- docs/api/v1.25.yaml | 2 +- docs/api/v1.26.yaml | 2 +- docs/api/v1.27.yaml | 2 +- docs/api/v1.28.yaml | 2 +- docs/api/v1.29.yaml | 2 +- docs/api/v1.30.yaml | 2 +- docs/api/v1.31.yaml | 2 +- docs/api/v1.32.yaml | 2 +- docs/api/v1.33.yaml | 2 +- docs/api/v1.34.yaml | 2 +- docs/api/v1.35.yaml | 2 +- docs/api/v1.36.yaml | 2 +- docs/api/v1.37.yaml | 2 +- docs/api/v1.38.yaml | 2 +- docs/api/v1.39.yaml | 2 +- docs/api/v1.40.yaml | 2 +- 17 files changed, 17 insertions(+), 17 deletions(-) diff --git a/api/swagger.yaml b/api/swagger.yaml index ca172599dc..0ff6490130 100644 --- a/api/swagger.yaml +++ b/api/swagger.yaml @@ -6923,7 +6923,7 @@ paths: type: "string" - name: "v" in: "query" - description: "Remove the volumes associated with the container." + description: "Remove anonymous volumes associated with the container." type: "boolean" default: false - name: "force" diff --git a/docs/api/v1.25.yaml b/docs/api/v1.25.yaml index ad97bb221b..6328960599 100644 --- a/docs/api/v1.25.yaml +++ b/docs/api/v1.25.yaml @@ -4021,7 +4021,7 @@ paths: type: "string" - name: "v" in: "query" - description: "Remove the volumes associated with the container." + description: "Remove anonymous volumes associated with the container." type: "boolean" default: false - name: "force" diff --git a/docs/api/v1.26.yaml b/docs/api/v1.26.yaml index d19e8c9ca8..81e296177a 100644 --- a/docs/api/v1.26.yaml +++ b/docs/api/v1.26.yaml @@ -4026,7 +4026,7 @@ paths: type: "string" - name: "v" in: "query" - description: "Remove the volumes associated with the container." + description: "Remove anonymous volumes associated with the container." type: "boolean" default: false - name: "force" diff --git a/docs/api/v1.27.yaml b/docs/api/v1.27.yaml index acbbe47543..29d8c6b106 100644 --- a/docs/api/v1.27.yaml +++ b/docs/api/v1.27.yaml @@ -4101,7 +4101,7 @@ paths: type: "string" - name: "v" in: "query" - description: "Remove the volumes associated with the container." + description: "Remove anonymous volumes associated with the container." type: "boolean" default: false - name: "force" diff --git a/docs/api/v1.28.yaml b/docs/api/v1.28.yaml index 7a46efa3ae..3dcfb88198 100644 --- a/docs/api/v1.28.yaml +++ b/docs/api/v1.28.yaml @@ -4193,7 +4193,7 @@ paths: type: "string" - name: "v" in: "query" - description: "Remove the volumes associated with the container." + description: "Remove anonymous volumes associated with the container." type: "boolean" default: false - name: "force" diff --git a/docs/api/v1.29.yaml b/docs/api/v1.29.yaml index 36927b5a04..1e92ab429d 100644 --- a/docs/api/v1.29.yaml +++ b/docs/api/v1.29.yaml @@ -4227,7 +4227,7 @@ paths: type: "string" - name: "v" in: "query" - description: "Remove the volumes associated with the container." + description: "Remove anonymous volumes associated with the container." type: "boolean" default: false - name: "force" diff --git a/docs/api/v1.30.yaml b/docs/api/v1.30.yaml index 7c4b946a75..2a071171a0 100644 --- a/docs/api/v1.30.yaml +++ b/docs/api/v1.30.yaml @@ -4450,7 +4450,7 @@ paths: type: "string" - name: "v" in: "query" - description: "Remove the volumes associated with the container." + description: "Remove anonymous volumes associated with the container." type: "boolean" default: false - name: "force" diff --git a/docs/api/v1.31.yaml b/docs/api/v1.31.yaml index 8710e00b5a..e8a4eba4cf 100644 --- a/docs/api/v1.31.yaml +++ b/docs/api/v1.31.yaml @@ -4520,7 +4520,7 @@ paths: type: "string" - name: "v" in: "query" - description: "Remove the volumes associated with the container." + description: "Remove anonymous volumes associated with the container." type: "boolean" default: false - name: "force" diff --git a/docs/api/v1.32.yaml b/docs/api/v1.32.yaml index 770f9890f6..499b11ba90 100644 --- a/docs/api/v1.32.yaml +++ b/docs/api/v1.32.yaml @@ -5757,7 +5757,7 @@ paths: type: "string" - name: "v" in: "query" - description: "Remove the volumes associated with the container." + description: "Remove anonymous volumes associated with the container." type: "boolean" default: false - name: "force" diff --git a/docs/api/v1.33.yaml b/docs/api/v1.33.yaml index af4acdd47b..bf21ce97d8 100644 --- a/docs/api/v1.33.yaml +++ b/docs/api/v1.33.yaml @@ -5762,7 +5762,7 @@ paths: type: "string" - name: "v" in: "query" - description: "Remove the volumes associated with the container." + description: "Remove anonymous volumes associated with the container." type: "boolean" default: false - name: "force" diff --git a/docs/api/v1.34.yaml b/docs/api/v1.34.yaml index 8e65d92367..11ac297d0f 100644 --- a/docs/api/v1.34.yaml +++ b/docs/api/v1.34.yaml @@ -5798,7 +5798,7 @@ paths: type: "string" - name: "v" in: "query" - description: "Remove the volumes associated with the container." + description: "Remove anonymous volumes associated with the container." type: "boolean" default: false - name: "force" diff --git a/docs/api/v1.35.yaml b/docs/api/v1.35.yaml index d28bfd3da0..0d78a41c40 100644 --- a/docs/api/v1.35.yaml +++ b/docs/api/v1.35.yaml @@ -5785,7 +5785,7 @@ paths: type: "string" - name: "v" in: "query" - description: "Remove the volumes associated with the container." + description: "Remove anonymous volumes associated with the container." type: "boolean" default: false - name: "force" diff --git a/docs/api/v1.36.yaml b/docs/api/v1.36.yaml index d0c879f8fd..d381e3895a 100644 --- a/docs/api/v1.36.yaml +++ b/docs/api/v1.36.yaml @@ -5809,7 +5809,7 @@ paths: type: "string" - name: "v" in: "query" - description: "Remove the volumes associated with the container." + description: "Remove anonymous volumes associated with the container." type: "boolean" default: false - name: "force" diff --git a/docs/api/v1.37.yaml b/docs/api/v1.37.yaml index 10f9964631..a4de19d8f5 100644 --- a/docs/api/v1.37.yaml +++ b/docs/api/v1.37.yaml @@ -5836,7 +5836,7 @@ paths: type: "string" - name: "v" in: "query" - description: "Remove the volumes associated with the container." + description: "Remove anonymous volumes associated with the container." type: "boolean" default: false - name: "force" diff --git a/docs/api/v1.38.yaml b/docs/api/v1.38.yaml index 4cd1e49c84..b29439feac 100644 --- a/docs/api/v1.38.yaml +++ b/docs/api/v1.38.yaml @@ -5897,7 +5897,7 @@ paths: type: "string" - name: "v" in: "query" - description: "Remove the volumes associated with the container." + description: "Remove anonymous volumes associated with the container." type: "boolean" default: false - name: "force" diff --git a/docs/api/v1.39.yaml b/docs/api/v1.39.yaml index 5fa201d479..84b6f29d57 100644 --- a/docs/api/v1.39.yaml +++ b/docs/api/v1.39.yaml @@ -6617,7 +6617,7 @@ paths: type: "string" - name: "v" in: "query" - description: "Remove the volumes associated with the container." + description: "Remove anonymous volumes associated with the container." type: "boolean" default: false - name: "force" diff --git a/docs/api/v1.40.yaml b/docs/api/v1.40.yaml index 70b09a0e3b..cf63d7279e 100644 --- a/docs/api/v1.40.yaml +++ b/docs/api/v1.40.yaml @@ -6755,7 +6755,7 @@ paths: type: "string" - name: "v" in: "query" - description: "Remove the volumes associated with the container." + description: "Remove anonymous volumes associated with the container." type: "boolean" default: false - name: "force"