core rest api docs out of date

Bug #1736541 reported by Kyle Nitzsche
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
snapd
Triaged
Medium
Unassigned

Bug Description

The following call:
GET /v2/system-info

Returns output [1] that is quite different [2] than what I see on a pi3 with:
snap 2.28.5
snapd 2.29.3
series 16
kernel 4.4.0-1030-raspi2

[1] Docs (https://docs.ubuntu.com/core/en/reference/rest) show this:
{
    "series": "16",
    "version": "2.0.17",
    "os-release": {
        "id": "ubuntu",
        "version-id": "17.04",
    },
    "on-classic": true,
    "managed": false
}

[2] system returns this:
{
    "type": "sync",
    "status-code": 200,
    "status": "OK",
    "result": {
        "confinement": "strict",
        "kernel-version": "4.4.0-1030-raspi2",
        "locations": {
            "snap-bin-dir": "/snap/bin",
            "snap-mount-dir": "/snap"
        },
        "managed": true,
        "on-classic": false,
        "os-release": {
            "id": "ubuntu-core",
            "version-id": "16"
        },
        "refresh": {
            "schedule": "00:00-04:59/5:00-10:59/11:00-16:59/17:00-23:59",
            "last": "2017-12-05T15:43:00Z",
            "next": "2017-12-05T17:41:00Z"
        },
        "series": "16",
        "version": "2.29.3"
    }
}

Tags: snap-docs
Revision history for this message
John Lenton (chipaca) wrote :

Agreed. However, note the docs talk exclusively about what's under "result", not the whole response -- things outside of "result" are documented elsewhere. There's a bunch of missing things in the doc, but it's not a completely different beast.

Revision history for this message
Kyle Nitzsche (knitzsche) wrote :

I was looking for documentation of "refresh" part and did not find it. Nor did I find a link to where the full set of docs is. So yes, this feels improvable.

description: updated
Michael Vogt (mvo)
Changed in snappy:
status: New → Triaged
importance: Undecided → Medium
Michael Vogt (mvo)
affects: snappy → snapd
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.