Browse code
api: clarify "v" option behavior in the container remove endpoint
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 <edigaryev@gmail.com>
Nikolay Edigaryev authored on 2020/09/23 18:22:10Showing 17 changed files
- api/swagger.yaml
- docs/api/v1.25.yaml
- docs/api/v1.26.yaml
- docs/api/v1.27.yaml
- docs/api/v1.28.yaml
- docs/api/v1.29.yaml
- docs/api/v1.30.yaml
- docs/api/v1.31.yaml
- docs/api/v1.32.yaml
- docs/api/v1.33.yaml
- docs/api/v1.34.yaml
- docs/api/v1.35.yaml
- docs/api/v1.36.yaml
- docs/api/v1.37.yaml
- docs/api/v1.38.yaml
- docs/api/v1.39.yaml
- docs/api/v1.40.yaml
| ... | ... |
@@ -6923,7 +6923,7 @@ paths: |
| 6923 | 6923 |
type: "string" |
| 6924 | 6924 |
- name: "v" |
| 6925 | 6925 |
in: "query" |
| 6926 |
- description: "Remove the volumes associated with the container." |
|
| 6926 |
+ description: "Remove anonymous volumes associated with the container." |
|
| 6927 | 6927 |
type: "boolean" |
| 6928 | 6928 |
default: false |
| 6929 | 6929 |
- name: "force" |
| ... | ... |
@@ -4021,7 +4021,7 @@ paths: |
| 4021 | 4021 |
type: "string" |
| 4022 | 4022 |
- name: "v" |
| 4023 | 4023 |
in: "query" |
| 4024 |
- description: "Remove the volumes associated with the container." |
|
| 4024 |
+ description: "Remove anonymous volumes associated with the container." |
|
| 4025 | 4025 |
type: "boolean" |
| 4026 | 4026 |
default: false |
| 4027 | 4027 |
- name: "force" |
| ... | ... |
@@ -4026,7 +4026,7 @@ paths: |
| 4026 | 4026 |
type: "string" |
| 4027 | 4027 |
- name: "v" |
| 4028 | 4028 |
in: "query" |
| 4029 |
- description: "Remove the volumes associated with the container." |
|
| 4029 |
+ description: "Remove anonymous volumes associated with the container." |
|
| 4030 | 4030 |
type: "boolean" |
| 4031 | 4031 |
default: false |
| 4032 | 4032 |
- name: "force" |
| ... | ... |
@@ -4101,7 +4101,7 @@ paths: |
| 4101 | 4101 |
type: "string" |
| 4102 | 4102 |
- name: "v" |
| 4103 | 4103 |
in: "query" |
| 4104 |
- description: "Remove the volumes associated with the container." |
|
| 4104 |
+ description: "Remove anonymous volumes associated with the container." |
|
| 4105 | 4105 |
type: "boolean" |
| 4106 | 4106 |
default: false |
| 4107 | 4107 |
- name: "force" |
| ... | ... |
@@ -4193,7 +4193,7 @@ paths: |
| 4193 | 4193 |
type: "string" |
| 4194 | 4194 |
- name: "v" |
| 4195 | 4195 |
in: "query" |
| 4196 |
- description: "Remove the volumes associated with the container." |
|
| 4196 |
+ description: "Remove anonymous volumes associated with the container." |
|
| 4197 | 4197 |
type: "boolean" |
| 4198 | 4198 |
default: false |
| 4199 | 4199 |
- name: "force" |
| ... | ... |
@@ -4227,7 +4227,7 @@ paths: |
| 4227 | 4227 |
type: "string" |
| 4228 | 4228 |
- name: "v" |
| 4229 | 4229 |
in: "query" |
| 4230 |
- description: "Remove the volumes associated with the container." |
|
| 4230 |
+ description: "Remove anonymous volumes associated with the container." |
|
| 4231 | 4231 |
type: "boolean" |
| 4232 | 4232 |
default: false |
| 4233 | 4233 |
- name: "force" |
| ... | ... |
@@ -4450,7 +4450,7 @@ paths: |
| 4450 | 4450 |
type: "string" |
| 4451 | 4451 |
- name: "v" |
| 4452 | 4452 |
in: "query" |
| 4453 |
- description: "Remove the volumes associated with the container." |
|
| 4453 |
+ description: "Remove anonymous volumes associated with the container." |
|
| 4454 | 4454 |
type: "boolean" |
| 4455 | 4455 |
default: false |
| 4456 | 4456 |
- name: "force" |
| ... | ... |
@@ -4520,7 +4520,7 @@ paths: |
| 4520 | 4520 |
type: "string" |
| 4521 | 4521 |
- name: "v" |
| 4522 | 4522 |
in: "query" |
| 4523 |
- description: "Remove the volumes associated with the container." |
|
| 4523 |
+ description: "Remove anonymous volumes associated with the container." |
|
| 4524 | 4524 |
type: "boolean" |
| 4525 | 4525 |
default: false |
| 4526 | 4526 |
- name: "force" |
| ... | ... |
@@ -5757,7 +5757,7 @@ paths: |
| 5757 | 5757 |
type: "string" |
| 5758 | 5758 |
- name: "v" |
| 5759 | 5759 |
in: "query" |
| 5760 |
- description: "Remove the volumes associated with the container." |
|
| 5760 |
+ description: "Remove anonymous volumes associated with the container." |
|
| 5761 | 5761 |
type: "boolean" |
| 5762 | 5762 |
default: false |
| 5763 | 5763 |
- name: "force" |
| ... | ... |
@@ -5762,7 +5762,7 @@ paths: |
| 5762 | 5762 |
type: "string" |
| 5763 | 5763 |
- name: "v" |
| 5764 | 5764 |
in: "query" |
| 5765 |
- description: "Remove the volumes associated with the container." |
|
| 5765 |
+ description: "Remove anonymous volumes associated with the container." |
|
| 5766 | 5766 |
type: "boolean" |
| 5767 | 5767 |
default: false |
| 5768 | 5768 |
- name: "force" |
| ... | ... |
@@ -5798,7 +5798,7 @@ paths: |
| 5798 | 5798 |
type: "string" |
| 5799 | 5799 |
- name: "v" |
| 5800 | 5800 |
in: "query" |
| 5801 |
- description: "Remove the volumes associated with the container." |
|
| 5801 |
+ description: "Remove anonymous volumes associated with the container." |
|
| 5802 | 5802 |
type: "boolean" |
| 5803 | 5803 |
default: false |
| 5804 | 5804 |
- name: "force" |
| ... | ... |
@@ -5785,7 +5785,7 @@ paths: |
| 5785 | 5785 |
type: "string" |
| 5786 | 5786 |
- name: "v" |
| 5787 | 5787 |
in: "query" |
| 5788 |
- description: "Remove the volumes associated with the container." |
|
| 5788 |
+ description: "Remove anonymous volumes associated with the container." |
|
| 5789 | 5789 |
type: "boolean" |
| 5790 | 5790 |
default: false |
| 5791 | 5791 |
- name: "force" |
| ... | ... |
@@ -5809,7 +5809,7 @@ paths: |
| 5809 | 5809 |
type: "string" |
| 5810 | 5810 |
- name: "v" |
| 5811 | 5811 |
in: "query" |
| 5812 |
- description: "Remove the volumes associated with the container." |
|
| 5812 |
+ description: "Remove anonymous volumes associated with the container." |
|
| 5813 | 5813 |
type: "boolean" |
| 5814 | 5814 |
default: false |
| 5815 | 5815 |
- name: "force" |
| ... | ... |
@@ -5836,7 +5836,7 @@ paths: |
| 5836 | 5836 |
type: "string" |
| 5837 | 5837 |
- name: "v" |
| 5838 | 5838 |
in: "query" |
| 5839 |
- description: "Remove the volumes associated with the container." |
|
| 5839 |
+ description: "Remove anonymous volumes associated with the container." |
|
| 5840 | 5840 |
type: "boolean" |
| 5841 | 5841 |
default: false |
| 5842 | 5842 |
- name: "force" |
| ... | ... |
@@ -5897,7 +5897,7 @@ paths: |
| 5897 | 5897 |
type: "string" |
| 5898 | 5898 |
- name: "v" |
| 5899 | 5899 |
in: "query" |
| 5900 |
- description: "Remove the volumes associated with the container." |
|
| 5900 |
+ description: "Remove anonymous volumes associated with the container." |
|
| 5901 | 5901 |
type: "boolean" |
| 5902 | 5902 |
default: false |
| 5903 | 5903 |
- name: "force" |
| ... | ... |
@@ -6617,7 +6617,7 @@ paths: |
| 6617 | 6617 |
type: "string" |
| 6618 | 6618 |
- name: "v" |
| 6619 | 6619 |
in: "query" |
| 6620 |
- description: "Remove the volumes associated with the container." |
|
| 6620 |
+ description: "Remove anonymous volumes associated with the container." |
|
| 6621 | 6621 |
type: "boolean" |
| 6622 | 6622 |
default: false |
| 6623 | 6623 |
- name: "force" |
| ... | ... |
@@ -6755,7 +6755,7 @@ paths: |
| 6755 | 6755 |
type: "string" |
| 6756 | 6756 |
- name: "v" |
| 6757 | 6757 |
in: "query" |
| 6758 |
- description: "Remove the volumes associated with the container." |
|
| 6758 |
+ description: "Remove anonymous volumes associated with the container." |
|
| 6759 | 6759 |
type: "boolean" |
| 6760 | 6760 |
default: false |
| 6761 | 6761 |
- name: "force" |