mirror of
https://github.com/moby/moby.git
synced 2022-11-09 12:21:53 -05:00
api: docs: move Volume examples inline (v1.39-v1.41)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
parent
e444ac3470
commit
5c0aae359f
3 changed files with 42 additions and 87 deletions
|
@ -1732,18 +1732,22 @@ definitions:
|
||||||
type: "string"
|
type: "string"
|
||||||
description: "Name of the volume."
|
description: "Name of the volume."
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "tardis"
|
||||||
Driver:
|
Driver:
|
||||||
type: "string"
|
type: "string"
|
||||||
description: "Name of the volume driver used by the volume."
|
description: "Name of the volume driver used by the volume."
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "custom"
|
||||||
Mountpoint:
|
Mountpoint:
|
||||||
type: "string"
|
type: "string"
|
||||||
description: "Mount path of the volume on the host."
|
description: "Mount path of the volume on the host."
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "/var/lib/docker/volumes/tardis"
|
||||||
CreatedAt:
|
CreatedAt:
|
||||||
type: "string"
|
type: "string"
|
||||||
format: "dateTime"
|
format: "dateTime"
|
||||||
description: "Date/Time the volume was created."
|
description: "Date/Time the volume was created."
|
||||||
|
example: "2016-06-07T20:31:11.853781916Z"
|
||||||
Status:
|
Status:
|
||||||
type: "object"
|
type: "object"
|
||||||
description: |
|
description: |
|
||||||
|
@ -1755,12 +1759,17 @@ definitions:
|
||||||
does not support this feature.
|
does not support this feature.
|
||||||
additionalProperties:
|
additionalProperties:
|
||||||
type: "object"
|
type: "object"
|
||||||
|
example:
|
||||||
|
hello: "world"
|
||||||
Labels:
|
Labels:
|
||||||
type: "object"
|
type: "object"
|
||||||
description: "User-defined key/value metadata."
|
description: "User-defined key/value metadata."
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
additionalProperties:
|
additionalProperties:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example:
|
||||||
|
com.example.some-label: "some-value"
|
||||||
|
com.example.some-other-label: "some-other-value"
|
||||||
Scope:
|
Scope:
|
||||||
type: "string"
|
type: "string"
|
||||||
description: |
|
description: |
|
||||||
|
@ -1769,12 +1778,17 @@ definitions:
|
||||||
default: "local"
|
default: "local"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
enum: ["local", "global"]
|
enum: ["local", "global"]
|
||||||
|
example: "local"
|
||||||
Options:
|
Options:
|
||||||
type: "object"
|
type: "object"
|
||||||
description: |
|
description: |
|
||||||
The driver specific options used when creating the volume.
|
The driver specific options used when creating the volume.
|
||||||
additionalProperties:
|
additionalProperties:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example:
|
||||||
|
device: "tmpfs"
|
||||||
|
o: "size=100m,uid=1000"
|
||||||
|
type: "tmpfs"
|
||||||
UsageData:
|
UsageData:
|
||||||
type: "object"
|
type: "object"
|
||||||
x-nullable: true
|
x-nullable: true
|
||||||
|
@ -1800,18 +1814,6 @@ definitions:
|
||||||
is set to `-1` if the reference-count is not available.
|
is set to `-1` if the reference-count is not available.
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
|
||||||
example:
|
|
||||||
Name: "tardis"
|
|
||||||
Driver: "custom"
|
|
||||||
Mountpoint: "/var/lib/docker/volumes/tardis"
|
|
||||||
Status:
|
|
||||||
hello: "world"
|
|
||||||
Labels:
|
|
||||||
com.example.some-label: "some-value"
|
|
||||||
com.example.some-other-label: "some-other-value"
|
|
||||||
Scope: "local"
|
|
||||||
CreatedAt: "2016-06-07T20:31:11.853781916Z"
|
|
||||||
|
|
||||||
Network:
|
Network:
|
||||||
type: "object"
|
type: "object"
|
||||||
properties:
|
properties:
|
||||||
|
@ -8451,23 +8453,6 @@ paths:
|
||||||
Warnings that occurred when fetching the list of volumes.
|
Warnings that occurred when fetching the list of volumes.
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
|
||||||
examples:
|
|
||||||
application/json:
|
|
||||||
Volumes:
|
|
||||||
- CreatedAt: "2017-07-19T12:00:26Z"
|
|
||||||
Name: "tardis"
|
|
||||||
Driver: "local"
|
|
||||||
Mountpoint: "/var/lib/docker/volumes/tardis"
|
|
||||||
Labels:
|
|
||||||
com.example.some-label: "some-value"
|
|
||||||
com.example.some-other-label: "some-other-value"
|
|
||||||
Scope: "local"
|
|
||||||
Options:
|
|
||||||
device: "tmpfs"
|
|
||||||
o: "size=100m,uid=1000"
|
|
||||||
type: "tmpfs"
|
|
||||||
Warnings: []
|
|
||||||
500:
|
500:
|
||||||
description: "Server error"
|
description: "Server error"
|
||||||
schema:
|
schema:
|
||||||
|
|
|
@ -1793,18 +1793,22 @@ definitions:
|
||||||
type: "string"
|
type: "string"
|
||||||
description: "Name of the volume."
|
description: "Name of the volume."
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "tardis"
|
||||||
Driver:
|
Driver:
|
||||||
type: "string"
|
type: "string"
|
||||||
description: "Name of the volume driver used by the volume."
|
description: "Name of the volume driver used by the volume."
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "custom"
|
||||||
Mountpoint:
|
Mountpoint:
|
||||||
type: "string"
|
type: "string"
|
||||||
description: "Mount path of the volume on the host."
|
description: "Mount path of the volume on the host."
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "/var/lib/docker/volumes/tardis"
|
||||||
CreatedAt:
|
CreatedAt:
|
||||||
type: "string"
|
type: "string"
|
||||||
format: "dateTime"
|
format: "dateTime"
|
||||||
description: "Date/Time the volume was created."
|
description: "Date/Time the volume was created."
|
||||||
|
example: "2016-06-07T20:31:11.853781916Z"
|
||||||
Status:
|
Status:
|
||||||
type: "object"
|
type: "object"
|
||||||
description: |
|
description: |
|
||||||
|
@ -1816,12 +1820,17 @@ definitions:
|
||||||
does not support this feature.
|
does not support this feature.
|
||||||
additionalProperties:
|
additionalProperties:
|
||||||
type: "object"
|
type: "object"
|
||||||
|
example:
|
||||||
|
hello: "world"
|
||||||
Labels:
|
Labels:
|
||||||
type: "object"
|
type: "object"
|
||||||
description: "User-defined key/value metadata."
|
description: "User-defined key/value metadata."
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
additionalProperties:
|
additionalProperties:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example:
|
||||||
|
com.example.some-label: "some-value"
|
||||||
|
com.example.some-other-label: "some-other-value"
|
||||||
Scope:
|
Scope:
|
||||||
type: "string"
|
type: "string"
|
||||||
description: |
|
description: |
|
||||||
|
@ -1830,12 +1839,17 @@ definitions:
|
||||||
default: "local"
|
default: "local"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
enum: ["local", "global"]
|
enum: ["local", "global"]
|
||||||
|
example: "local"
|
||||||
Options:
|
Options:
|
||||||
type: "object"
|
type: "object"
|
||||||
description: |
|
description: |
|
||||||
The driver specific options used when creating the volume.
|
The driver specific options used when creating the volume.
|
||||||
additionalProperties:
|
additionalProperties:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example:
|
||||||
|
device: "tmpfs"
|
||||||
|
o: "size=100m,uid=1000"
|
||||||
|
type: "tmpfs"
|
||||||
UsageData:
|
UsageData:
|
||||||
type: "object"
|
type: "object"
|
||||||
x-nullable: true
|
x-nullable: true
|
||||||
|
@ -1861,18 +1875,6 @@ definitions:
|
||||||
is set to `-1` if the reference-count is not available.
|
is set to `-1` if the reference-count is not available.
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
|
||||||
example:
|
|
||||||
Name: "tardis"
|
|
||||||
Driver: "custom"
|
|
||||||
Mountpoint: "/var/lib/docker/volumes/tardis"
|
|
||||||
Status:
|
|
||||||
hello: "world"
|
|
||||||
Labels:
|
|
||||||
com.example.some-label: "some-value"
|
|
||||||
com.example.some-other-label: "some-other-value"
|
|
||||||
Scope: "local"
|
|
||||||
CreatedAt: "2016-06-07T20:31:11.853781916Z"
|
|
||||||
|
|
||||||
Network:
|
Network:
|
||||||
type: "object"
|
type: "object"
|
||||||
properties:
|
properties:
|
||||||
|
@ -8784,23 +8786,6 @@ paths:
|
||||||
Warnings that occurred when fetching the list of volumes.
|
Warnings that occurred when fetching the list of volumes.
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
|
||||||
examples:
|
|
||||||
application/json:
|
|
||||||
Volumes:
|
|
||||||
- CreatedAt: "2017-07-19T12:00:26Z"
|
|
||||||
Name: "tardis"
|
|
||||||
Driver: "local"
|
|
||||||
Mountpoint: "/var/lib/docker/volumes/tardis"
|
|
||||||
Labels:
|
|
||||||
com.example.some-label: "some-value"
|
|
||||||
com.example.some-other-label: "some-other-value"
|
|
||||||
Scope: "local"
|
|
||||||
Options:
|
|
||||||
device: "tmpfs"
|
|
||||||
o: "size=100m,uid=1000"
|
|
||||||
type: "tmpfs"
|
|
||||||
Warnings: []
|
|
||||||
500:
|
500:
|
||||||
description: "Server error"
|
description: "Server error"
|
||||||
schema:
|
schema:
|
||||||
|
|
|
@ -1825,18 +1825,22 @@ definitions:
|
||||||
type: "string"
|
type: "string"
|
||||||
description: "Name of the volume."
|
description: "Name of the volume."
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "tardis"
|
||||||
Driver:
|
Driver:
|
||||||
type: "string"
|
type: "string"
|
||||||
description: "Name of the volume driver used by the volume."
|
description: "Name of the volume driver used by the volume."
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "custom"
|
||||||
Mountpoint:
|
Mountpoint:
|
||||||
type: "string"
|
type: "string"
|
||||||
description: "Mount path of the volume on the host."
|
description: "Mount path of the volume on the host."
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "/var/lib/docker/volumes/tardis"
|
||||||
CreatedAt:
|
CreatedAt:
|
||||||
type: "string"
|
type: "string"
|
||||||
format: "dateTime"
|
format: "dateTime"
|
||||||
description: "Date/Time the volume was created."
|
description: "Date/Time the volume was created."
|
||||||
|
example: "2016-06-07T20:31:11.853781916Z"
|
||||||
Status:
|
Status:
|
||||||
type: "object"
|
type: "object"
|
||||||
description: |
|
description: |
|
||||||
|
@ -1848,12 +1852,17 @@ definitions:
|
||||||
does not support this feature.
|
does not support this feature.
|
||||||
additionalProperties:
|
additionalProperties:
|
||||||
type: "object"
|
type: "object"
|
||||||
|
example:
|
||||||
|
hello: "world"
|
||||||
Labels:
|
Labels:
|
||||||
type: "object"
|
type: "object"
|
||||||
description: "User-defined key/value metadata."
|
description: "User-defined key/value metadata."
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
additionalProperties:
|
additionalProperties:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example:
|
||||||
|
com.example.some-label: "some-value"
|
||||||
|
com.example.some-other-label: "some-other-value"
|
||||||
Scope:
|
Scope:
|
||||||
type: "string"
|
type: "string"
|
||||||
description: |
|
description: |
|
||||||
|
@ -1862,12 +1871,17 @@ definitions:
|
||||||
default: "local"
|
default: "local"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
enum: ["local", "global"]
|
enum: ["local", "global"]
|
||||||
|
example: "local"
|
||||||
Options:
|
Options:
|
||||||
type: "object"
|
type: "object"
|
||||||
description: |
|
description: |
|
||||||
The driver specific options used when creating the volume.
|
The driver specific options used when creating the volume.
|
||||||
additionalProperties:
|
additionalProperties:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example:
|
||||||
|
device: "tmpfs"
|
||||||
|
o: "size=100m,uid=1000"
|
||||||
|
type: "tmpfs"
|
||||||
UsageData:
|
UsageData:
|
||||||
type: "object"
|
type: "object"
|
||||||
x-nullable: true
|
x-nullable: true
|
||||||
|
@ -1893,18 +1907,6 @@ definitions:
|
||||||
is set to `-1` if the reference-count is not available.
|
is set to `-1` if the reference-count is not available.
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
|
||||||
example:
|
|
||||||
Name: "tardis"
|
|
||||||
Driver: "custom"
|
|
||||||
Mountpoint: "/var/lib/docker/volumes/tardis"
|
|
||||||
Status:
|
|
||||||
hello: "world"
|
|
||||||
Labels:
|
|
||||||
com.example.some-label: "some-value"
|
|
||||||
com.example.some-other-label: "some-other-value"
|
|
||||||
Scope: "local"
|
|
||||||
CreatedAt: "2016-06-07T20:31:11.853781916Z"
|
|
||||||
|
|
||||||
Network:
|
Network:
|
||||||
type: "object"
|
type: "object"
|
||||||
properties:
|
properties:
|
||||||
|
@ -8955,23 +8957,6 @@ paths:
|
||||||
Warnings that occurred when fetching the list of volumes.
|
Warnings that occurred when fetching the list of volumes.
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
|
||||||
examples:
|
|
||||||
application/json:
|
|
||||||
Volumes:
|
|
||||||
- CreatedAt: "2017-07-19T12:00:26Z"
|
|
||||||
Name: "tardis"
|
|
||||||
Driver: "local"
|
|
||||||
Mountpoint: "/var/lib/docker/volumes/tardis"
|
|
||||||
Labels:
|
|
||||||
com.example.some-label: "some-value"
|
|
||||||
com.example.some-other-label: "some-other-value"
|
|
||||||
Scope: "local"
|
|
||||||
Options:
|
|
||||||
device: "tmpfs"
|
|
||||||
o: "size=100m,uid=1000"
|
|
||||||
type: "tmpfs"
|
|
||||||
Warnings: []
|
|
||||||
500:
|
500:
|
||||||
description: "Server error"
|
description: "Server error"
|
||||||
schema:
|
schema:
|
||||||
|
|
Loading…
Add table
Reference in a new issue