Skip to content

Commit 9414c56

Browse files
authored
Merge pull request #2815 from Dorthu/feature/document-image-distro
Documents accepting distributions as images
2 parents 658c601 + 7a9a454 commit 9414c56

File tree

2 files changed

+20
-13
lines changed

2 files changed

+20
-13
lines changed

docs/src/data/endpoints/linodes.yaml

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ endpoints:
5454
if 'backup_id' or 'image' is sent.
5555
type: String
5656
deprecated: This parameter is deprecated and will be removed before the end of the Beta Period.
57-
See the changelog for more information.
57+
You can provide the same inputs to "image" instead. See the changelog for more information.
5858
root_pass:
5959
optional: unless source == "distro"
6060
description: >
@@ -90,8 +90,11 @@ endpoints:
9090
optional: true
9191
description: >
9292
The gold-master image to use for the newly created Linode. May
93-
not be included if 'distribution' or 'backup_id' is sent.
94-
type: Integer
93+
not be included if 'distribution' or 'backup_id' is sent. Official
94+
images start with "linode/", while your own images start with
95+
"private/"
96+
type: String
97+
value: "linode/debian9"
9598
backups_enabled:
9699
optional: true
97100
description: >
@@ -199,13 +202,15 @@ endpoints:
199202
is created.</li></ul> You may not provide distribution if image is provided.
200203
type: String
201204
deprecated: This parameter is deprecated and will be removed before the end of the Beta Period.
202-
See the changelog for more information.
205+
The same value can be passed to "image" instead. See the changelog for more information.
203206
image:
204207
optional: true
205208
description: >
206209
Optional image id to deploy the disk from. You may not provide image
207-
if distribution is provided.
210+
if distribution is provided. Official images start with "linode/",
211+
while your images start with "private/"
208212
seeAlso: ["/reference/endpoints/images"]
213+
type: String
209214
root_pass:
210215
optional: unless distribution or image is specified
211216
description: >
@@ -1023,8 +1028,10 @@ endpoints:
10231028
optional: true
10241029
description: >
10251030
The gold-master image to use for this Linode. May
1026-
not be included if 'distribution' is sent.
1027-
type: Integer
1031+
not be included if 'distribution' is sent. Official images start
1032+
with "linode/", while your own images start with "private/"
1033+
type: String
1034+
value: "linode/debian9"
10281035
root_pass:
10291036
description: >
10301037
The root password for the new deployment.

docs/src/data/objects/linode.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,13 +72,13 @@ schema:
7272
seeAlso: "/reference/endpoints/regions"
7373
description: This Linode's region.
7474
value: us-east-1a
75-
distribution:
76-
description: The distribution that this Linode booted to last.
77-
type: Distribution
78-
seeAlso: "/reference/endpoints/linode/distributions"
75+
image:
76+
description: >
77+
The image that this Linode booted to last, if known. Currently this will
78+
only display official images.
79+
type: Image
80+
seeAlso: "/reference/endpoints/images"
7981
filterable: true
80-
deprecated: This parameter is deprecated and will be removed before the end of the Beta Period.
81-
See the changelog for more information.
8282
group:
8383
editable: true
8484
type: String

0 commit comments

Comments
 (0)