docs: API updates to reflect reality #1379

Merged
merged 7 commits into from Jun 28, 2016

Conversation

Projects
None yet
5 participants
Contributor

robert-ancell commented Jun 21, 2016

No description provided.

Contributor

snappy-m-o commented Jun 21, 2016

Can one of the admins verify this patch?

Contributor

snappy-m-o commented Jun 21, 2016

Can one of the admins verify this patch?

Contributor

robert-ancell commented Jun 21, 2016

I've attempted to document all the fields as returned from snapd, some of them I'm not sure what they mean exactly so please check if the descriptions could be improved.

Collaborator

mvo5 commented Jun 22, 2016

add to whitelist

Collaborator

mvo5 commented Jun 22, 2016

Thanks for this update! 👍

Contributor

zyga commented Jun 22, 2016

Looks good

docs/rest.md
@@ -225,14 +229,20 @@ snaps is supported via the `refresh` key.
[//]: # keep the fields sorted, both in the description and the sample above. Makes scanning easier
-* `description`: snap description
+* `channel`: which channel the package is currently tracking.
@niemeyer

niemeyer Jun 22, 2016

Contributor

s/package/snap/

docs/rest.md
@@ -225,14 +229,20 @@ snaps is supported via the `refresh` key.
[//]: # keep the fields sorted, both in the description and the sample above. Makes scanning easier
-* `description`: snap description
+* `channel`: which channel the package is currently tracking.
+* `confinement`: the confinement used; one of `strict` or `devmode`.
@niemeyer

niemeyer Jun 22, 2016

Contributor
* `confinement`: the confinement requested by the snap itself; one of `strict` or `devmode`.
* `devmode`: whether the snap is currently installed in development mode
@niemeyer

niemeyer Jun 22, 2016

Contributor

Sorry, devmode should go below. This is the results from find only.

docs/rest.md
* `download-size`: how big the download will be.
* `icon`: a url to the snap icon, possibly relative to this server.
+* `id`: Unique ID for this snap
@niemeyer

niemeyer Jun 22, 2016

Contributor

s/U/u/

@niemeyer

niemeyer Jun 22, 2016

Contributor

and s/$/./, looks like the common end of line here.

docs/rest.md
* `name`: the snap name.
* `prices`: JSON object with properties named by ISO 4217 currency code. The values of the properties are numerics representing the cost in each currency. For free snaps, the "prices" property is omitted.
+* `private`: true if this is not a publically available snap.
@niemeyer

niemeyer Jun 22, 2016

Contributor
* `private`: whether this snap is available to its author only or public
docs/rest.md
* `installed-size`: how much space the snap itself (not its data) uses.
* `install-date`: the date and time when the snap was installed.
-* `status`: can be either `installed` or `active` (i.e. is current).
+* `trymode`: true if the app was installed in try mode.
@niemeyer

niemeyer Jun 22, 2016

Contributor

Please copy the devmode description here.

Also, why was status dropped? Note that the description differs.

@niemeyer niemeyer changed the title from Snapd docs update to docs: API updates to reflect reality Jun 22, 2016

robert-ancell added some commits Jun 22, 2016

Contributor

niemeyer commented Jun 28, 2016

THanks!

Contributor

snappy-m-o commented Jun 28, 2016

Can one of the admins verify this patch?

Contributor

snappy-m-o commented Jun 28, 2016

Can one of the admins verify this patch?

Contributor

snappy-m-o commented Jun 28, 2016

Can one of the admins verify this patch?

@niemeyer niemeyer merged commit 371d306 into snapcore:master Jun 28, 2016

1 of 3 checks passed

Integration tests Started
Details
autopkgtest Started
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@niemeyer niemeyer referenced this pull request in ubuntu-core/snappy-jenkins Jun 29, 2016

Open

Bot spams pull requests unnecessarily #184

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment