Skip to content

Commit 59cf944

Browse files
authored
Merge pull request #2821 from SzySteve/docs/distribution
documentation for distribution/image unification
2 parents 9414c56 + b049449 commit 59cf944

File tree

3 files changed

+21
-9
lines changed

3 files changed

+21
-9
lines changed

docs/src/data/endpoints/images.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ endpoints:
1010
methods:
1111
GET:
1212
response: image
13+
paginationKey: images
1314
oauth: 'images:view'
1415
description: |
1516
Returns a list of images.
@@ -38,7 +39,7 @@ endpoints:
3839
PUT:
3940
oauth: 'images:modify'
4041
description: |
41-
Modifies a given image
42+
Modifies a given image. Only private images belonging to you are modifiable.
4243
examples:
4344
curl: |
4445
curl -H "Content-Type: application/json" \
@@ -54,7 +55,7 @@ endpoints:
5455
DELETE:
5556
oauth: 'images:delete'
5657
description: |
57-
Deletes a given image
58+
Deletes a given image.Only private images belonging to you are deletable.
5859
examples:
5960
curl: |
6061
curl -H "Authorization: Bearer $TOKEN" \

docs/src/data/endpoints/linodes.yaml

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1188,13 +1188,14 @@ endpoints:
11881188
/linode/distributions:
11891189
group: Distributions
11901190
description: >
1191-
View the collection of distributions.
1191+
THIS ENDPOINT IS DEPRECATED. USE /images INSTEAD. Returns information about this distribution.
11921192
methods:
11931193
GET:
1194-
response: distribution
1194+
response: image
11951195
paginationKey: distributions
11961196
description: >
1197-
Returns a list of distributions.
1197+
THIS ENDPOINT IS DEPRECATED. USE /images INSTEAD. Returns information about this distribution.
1198+
seeAlso: ["/reference/endpoints/images"]
11981199
examples:
11991200
curl: |
12001201
curl https://$api_root/$version/linode/distributions
@@ -1204,12 +1205,13 @@ endpoints:
12041205
group: Distributions
12051206
type: resource
12061207
description: >
1207-
Returns information about a specific distribution.
1208+
THIS ENDPOINT IS DEPRECATED. USE /images INSTEAD. Returns information about this distribution.
12081209
methods:
12091210
GET:
1210-
response: distribution
1211+
response: image
12111212
description: >
1212-
Returns information about this distribution.
1213+
THIS ENDPOINT IS DEPRECATED. USE /images INSTEAD. Returns information about this distribution.
1214+
seeAlso: ["/reference/endpoints/images"]
12131215
examples:
12141216
curl: |
12151217
curl https://$api_root/$version/linode/distributions/$distribution_id

docs/src/data/objects/image.yaml

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
name: Image
22
description: >
3-
Image objects describe an image that was made based off a device on a Linode
3+
Image objects describe an image that was made based off a device, or an official
4+
image created by Linode for public use.
45
schema:
56
id:
67
type: Integer
@@ -53,3 +54,11 @@ schema:
5354
type: String
5455
value: "2017-10-19T11:21:01"
5556
description: The last time this image was used.
57+
min_deploy_size:
58+
type: Integer
59+
value: 1000
60+
description: The minimum size this image needs to deploy.
61+
creator:
62+
type: String
63+
value: your_username
64+
description: The name of the user who created this image, or linode for official images.

0 commit comments

Comments
 (0)