Skip to content

Commit 5c0aae3

Browse files
thaJeztahthaJeztah
committed
api: docs: move Volume examples inline (v1.39-v1.41)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
1 parent e444ac3 commit 5c0aae3

File tree

3 files changed

+42
-87
lines changed

3 files changed

+42
-87
lines changed

‎docs/api/v1.39.yaml‎

Lines changed: 14 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1732,18 +1732,22 @@ definitions:
17321732
type: "string"
17331733
description: "Name of the volume."
17341734
x-nullable: false
1735+
example: "tardis"
17351736
Driver:
17361737
type: "string"
17371738
description: "Name of the volume driver used by the volume."
17381739
x-nullable: false
1740+
example: "custom"
17391741
Mountpoint:
17401742
type: "string"
17411743
description: "Mount path of the volume on the host."
17421744
x-nullable: false
1745+
example: "/var/lib/docker/volumes/tardis"
17431746
CreatedAt:
17441747
type: "string"
17451748
format: "dateTime"
17461749
description: "Date/Time the volume was created."
1750+
example: "2016-06-07T20:31:11.853781916Z"
17471751
Status:
17481752
type: "object"
17491753
description: |
@@ -1755,12 +1759,17 @@ definitions:
17551759
does not support this feature.
17561760
additionalProperties:
17571761
type: "object"
1762+
example:
1763+
hello: "world"
17581764
Labels:
17591765
type: "object"
17601766
description: "User-defined key/value metadata."
17611767
x-nullable: false
17621768
additionalProperties:
17631769
type: "string"
1770+
example:
1771+
com.example.some-label: "some-value"
1772+
com.example.some-other-label: "some-other-value"
17641773
Scope:
17651774
type: "string"
17661775
description: |
@@ -1769,12 +1778,17 @@ definitions:
17691778
default: "local"
17701779
x-nullable: false
17711780
enum: ["local", "global"]
1781+
example: "local"
17721782
Options:
17731783
type: "object"
17741784
description: |
17751785
The driver specific options used when creating the volume.
17761786
additionalProperties:
17771787
type: "string"
1788+
example:
1789+
device: "tmpfs"
1790+
o: "size=100m,uid=1000"
1791+
type: "tmpfs"
17781792
UsageData:
17791793
type: "object"
17801794
x-nullable: true
@@ -1800,18 +1814,6 @@ definitions:
18001814
is set to `-1` if the reference-count is not available.
18011815
x-nullable: false
18021816

1803-
example:
1804-
Name: "tardis"
1805-
Driver: "custom"
1806-
Mountpoint: "/var/lib/docker/volumes/tardis"
1807-
Status:
1808-
hello: "world"
1809-
Labels:
1810-
com.example.some-label: "some-value"
1811-
com.example.some-other-label: "some-other-value"
1812-
Scope: "local"
1813-
CreatedAt: "2016-06-07T20:31:11.853781916Z"
1814-
18151817
Network:
18161818
type: "object"
18171819
properties:
@@ -8451,23 +8453,6 @@ paths:
84518453
Warnings that occurred when fetching the list of volumes.
84528454
items:
84538455
type: "string"
8454-
8455-
examples:
8456-
application/json:
8457-
Volumes:
8458-
- CreatedAt: "2017-07-19T12:00:26Z"
8459-
Name: "tardis"
8460-
Driver: "local"
8461-
Mountpoint: "/var/lib/docker/volumes/tardis"
8462-
Labels:
8463-
com.example.some-label: "some-value"
8464-
com.example.some-other-label: "some-other-value"
8465-
Scope: "local"
8466-
Options:
8467-
device: "tmpfs"
8468-
o: "size=100m,uid=1000"
8469-
type: "tmpfs"
8470-
Warnings: []
84718456
500:
84728457
description: "Server error"
84738458
schema:

‎docs/api/v1.40.yaml‎

Lines changed: 14 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1793,18 +1793,22 @@ definitions:
17931793
type: "string"
17941794
description: "Name of the volume."
17951795
x-nullable: false
1796+
example: "tardis"
17961797
Driver:
17971798
type: "string"
17981799
description: "Name of the volume driver used by the volume."
17991800
x-nullable: false
1801+
example: "custom"
18001802
Mountpoint:
18011803
type: "string"
18021804
description: "Mount path of the volume on the host."
18031805
x-nullable: false
1806+
example: "/var/lib/docker/volumes/tardis"
18041807
CreatedAt:
18051808
type: "string"
18061809
format: "dateTime"
18071810
description: "Date/Time the volume was created."
1811+
example: "2016-06-07T20:31:11.853781916Z"
18081812
Status:
18091813
type: "object"
18101814
description: |
@@ -1816,12 +1820,17 @@ definitions:
18161820
does not support this feature.
18171821
additionalProperties:
18181822
type: "object"
1823+
example:
1824+
hello: "world"
18191825
Labels:
18201826
type: "object"
18211827
description: "User-defined key/value metadata."
18221828
x-nullable: false
18231829
additionalProperties:
18241830
type: "string"
1831+
example:
1832+
com.example.some-label: "some-value"
1833+
com.example.some-other-label: "some-other-value"
18251834
Scope:
18261835
type: "string"
18271836
description: |
@@ -1830,12 +1839,17 @@ definitions:
18301839
default: "local"
18311840
x-nullable: false
18321841
enum: ["local", "global"]
1842+
example: "local"
18331843
Options:
18341844
type: "object"
18351845
description: |
18361846
The driver specific options used when creating the volume.
18371847
additionalProperties:
18381848
type: "string"
1849+
example:
1850+
device: "tmpfs"
1851+
o: "size=100m,uid=1000"
1852+
type: "tmpfs"
18391853
UsageData:
18401854
type: "object"
18411855
x-nullable: true
@@ -1861,18 +1875,6 @@ definitions:
18611875
is set to `-1` if the reference-count is not available.
18621876
x-nullable: false
18631877

1864-
example:
1865-
Name: "tardis"
1866-
Driver: "custom"
1867-
Mountpoint: "/var/lib/docker/volumes/tardis"
1868-
Status:
1869-
hello: "world"
1870-
Labels:
1871-
com.example.some-label: "some-value"
1872-
com.example.some-other-label: "some-other-value"
1873-
Scope: "local"
1874-
CreatedAt: "2016-06-07T20:31:11.853781916Z"
1875-
18761878
Network:
18771879
type: "object"
18781880
properties:
@@ -8784,23 +8786,6 @@ paths:
87848786
Warnings that occurred when fetching the list of volumes.
87858787
items:
87868788
type: "string"
8787-
8788-
examples:
8789-
application/json:
8790-
Volumes:
8791-
- CreatedAt: "2017-07-19T12:00:26Z"
8792-
Name: "tardis"
8793-
Driver: "local"
8794-
Mountpoint: "/var/lib/docker/volumes/tardis"
8795-
Labels:
8796-
com.example.some-label: "some-value"
8797-
com.example.some-other-label: "some-other-value"
8798-
Scope: "local"
8799-
Options:
8800-
device: "tmpfs"
8801-
o: "size=100m,uid=1000"
8802-
type: "tmpfs"
8803-
Warnings: []
88048789
500:
88058790
description: "Server error"
88068791
schema:

‎docs/api/v1.41.yaml‎

Lines changed: 14 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1825,18 +1825,22 @@ definitions:
18251825
type: "string"
18261826
description: "Name of the volume."
18271827
x-nullable: false
1828+
example: "tardis"
18281829
Driver:
18291830
type: "string"
18301831
description: "Name of the volume driver used by the volume."
18311832
x-nullable: false
1833+
example: "custom"
18321834
Mountpoint:
18331835
type: "string"
18341836
description: "Mount path of the volume on the host."
18351837
x-nullable: false
1838+
example: "/var/lib/docker/volumes/tardis"
18361839
CreatedAt:
18371840
type: "string"
18381841
format: "dateTime"
18391842
description: "Date/Time the volume was created."
1843+
example: "2016-06-07T20:31:11.853781916Z"
18401844
Status:
18411845
type: "object"
18421846
description: |
@@ -1848,12 +1852,17 @@ definitions:
18481852
does not support this feature.
18491853
additionalProperties:
18501854
type: "object"
1855+
example:
1856+
hello: "world"
18511857
Labels:
18521858
type: "object"
18531859
description: "User-defined key/value metadata."
18541860
x-nullable: false
18551861
additionalProperties:
18561862
type: "string"
1863+
example:
1864+
com.example.some-label: "some-value"
1865+
com.example.some-other-label: "some-other-value"
18571866
Scope:
18581867
type: "string"
18591868
description: |
@@ -1862,12 +1871,17 @@ definitions:
18621871
default: "local"
18631872
x-nullable: false
18641873
enum: ["local", "global"]
1874+
example: "local"
18651875
Options:
18661876
type: "object"
18671877
description: |
18681878
The driver specific options used when creating the volume.
18691879
additionalProperties:
18701880
type: "string"
1881+
example:
1882+
device: "tmpfs"
1883+
o: "size=100m,uid=1000"
1884+
type: "tmpfs"
18711885
UsageData:
18721886
type: "object"
18731887
x-nullable: true
@@ -1893,18 +1907,6 @@ definitions:
18931907
is set to `-1` if the reference-count is not available.
18941908
x-nullable: false
18951909

1896-
example:
1897-
Name: "tardis"
1898-
Driver: "custom"
1899-
Mountpoint: "/var/lib/docker/volumes/tardis"
1900-
Status:
1901-
hello: "world"
1902-
Labels:
1903-
com.example.some-label: "some-value"
1904-
com.example.some-other-label: "some-other-value"
1905-
Scope: "local"
1906-
CreatedAt: "2016-06-07T20:31:11.853781916Z"
1907-
19081910
Network:
19091911
type: "object"
19101912
properties:
@@ -8955,23 +8957,6 @@ paths:
89558957
Warnings that occurred when fetching the list of volumes.
89568958
items:
89578959
type: "string"
8958-
8959-
examples:
8960-
application/json:
8961-
Volumes:
8962-
- CreatedAt: "2017-07-19T12:00:26Z"
8963-
Name: "tardis"
8964-
Driver: "local"
8965-
Mountpoint: "/var/lib/docker/volumes/tardis"
8966-
Labels:
8967-
com.example.some-label: "some-value"
8968-
com.example.some-other-label: "some-other-value"
8969-
Scope: "local"
8970-
Options:
8971-
device: "tmpfs"
8972-
o: "size=100m,uid=1000"
8973-
type: "tmpfs"
8974-
Warnings: []
89758960
500:
89768961
description: "Server error"
89778962
schema:

0 commit comments

Comments
 (0)