Skip to content

Commit ffee7ed

Browse files
committed
Update Image Upload CLI settings
1 parent c1a433b commit ffee7ed

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

openapi.yaml

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3858,15 +3858,16 @@ paths:
38583858
- Uploaded image data should be compressed in gzip (`.gz`) format. The uncompressed disk should be in raw
38593859
disk image (`.img`) format. A maximum compressed file size of 5GB is supported for upload at this time.
38603860

3861-
- To initiate and complete and upload in a single step, see our guide on how to [Upload an Image](/docs/products/tools/images/guides/upload-an-image/) using Cloud Manager or the Linode CLI.
3861+
**Note:** To initiate and complete an Image upload in a single step, see our guide on how to [Upload an Image](/docs/products/tools/images/guides/upload-an-image/) using Cloud Manager or the Linode CLI `image-upload` plugin.
38623862
x-linode-cli-action: upload
3863-
x-linode-cli-skip: true
38643863
security:
38653864
- personalAccessToken: []
38663865
- oauth:
38673866
- images:read_write
38683867
requestBody:
38693868
description: The uploaded Image details.
3869+
x-linode-cli-allowed-defaults:
3870+
- region
38703871
content:
38713872
application/json:
38723873
schema:
@@ -3890,7 +3891,7 @@ paths:
38903891
example: This is an example image in the docs.
38913892
responses:
38923893
'200':
3893-
description: The new Image upload URL.
3894+
description: Image Upload object including the upload URL and Image object.
38943895
content:
38953896
application/json:
38963897
schema:
@@ -3899,6 +3900,7 @@ paths:
38993900
upload_to:
39003901
type: string
39013902
description: The URL to upload the Image to.
3903+
x-linode-cli-display: 1
39023904
image:
39033905
$ref: '#/components/schemas/Image'
39043906
default:
@@ -3909,18 +3911,17 @@ paths:
39093911
curl -H "Content-Type: application/json" \
39103912
-H "Authorization: Bearer $TOKEN" \
39113913
-X POST -d '{
3912-
"description": "This is an example Machine Image.",
3913-
"label": "example-machine-image-label",
3914+
"description": "Optional details about the Image",
3915+
"label": "Example Image",
39143916
"region": "us-east"
39153917
}' \
39163918
https://api.linode.com/v4/images/upload
39173919
- lang: CLI
39183920
source: >
3919-
linode-cli image-upload \
3921+
linode-cli images upload \
3922+
--description "Optional details about the Image" \
39203923
--label "Example Image" \
3921-
--description "Some details about the image" \
3922-
--region us-east \
3923-
~/Downloads/image-file.img.gz
3924+
--region us-east
39243925
/images/{imageId}:
39253926
x-linode-cli-command: images
39263927
parameters:

0 commit comments

Comments
 (0)