diff options
| author | Robert Ancell <robert.ancell@canonical.com> | 2016-09-21 11:25:37 +1200 |
|---|---|---|
| committer | Robert Ancell <robert.ancell@canonical.com> | 2016-09-21 15:37:01 +1200 |
| commit | bc367008a827032dcda0d73ea3963c7946e4b416 (patch) | |
| tree | 366f87583d09c9a3635969fec76e3421f6035504 /docs | |
| parent | 98c8e937625ce3134cf17025d8f0eb3e1016259a (diff) | |
Pass through screenshots from snap store
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/rest.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/rest.md b/docs/rest.md index 0a3a3da048..4109520a19 100644 --- a/docs/rest.md +++ b/docs/rest.md @@ -246,6 +246,7 @@ Alter the collection searched: "name": "http", "resource": "/v2/snaps/http", "revision": 14, + "screenshots": [{url: "https://myapps.developer.ubuntu.com/site_media/appmedia/2015/10/screenshot.png", width: 800, height: 1280}], "status": "available", "summary": "HTTPie in a snap", "type": "app", @@ -269,6 +270,7 @@ Alter the collection searched: * `private`: true if this snap is only available to its author. * `resource`: HTTP resource for this snap. * `revision`: a number representing the revision. +* `screenshots`: JSON array of the screenshots for this snap. Each screenshot has a `url` field for the image and optionally `width` and `height` (in pixels). * `status`: can be either `available`, or `priced` (i.e. needs to be bought to become available). * `summary`: one-line summary. * `type`: the type of snap; one of `app`, `kernel`, `gadget`, or `os`. @@ -354,7 +356,7 @@ In addition to the fields described in `/v2/find`: * `status`: can be either `installed` or `active` (i.e. is current). * `trymode`: true if the app was installed in try mode. -furthermore, `download-size` and `price` cannot occur in the output of `/v2/snaps`. +furthermore, `download-size`, `screenshots` and `prices` cannot occur in the output of `/v2/snaps`. ### POST |