Skip to main content

CatalogList

serialinteger<int64>required

The installed catalog's serial.

generatedAtstring<date-time>

When the catalog archive was built; absent when its index carries no time.

templates object[]required
  • Array [
  • idstringrequired
    revisionintegerrequired

    Increases with every change to the template.

    Possible values: >= 1

    titlestringrequired
    categoriesstring[]required
    docsstringrequired

    The upstream documentation the template was written from.

    maintainerstring

    Who maintains the template or the app, as the catalog's index lists it. Absent when the template names none.

    Possible values: non-empty and <= 100 characters

    descriptionstring

    The template's description as the catalog's index lists it; the catalog card shows an excerpt. Plain text, never markup. Absent when the template has none.

    Possible values: non-empty and <= 2000 characters

    sourcestringrequired

    Where the entry came from: hoserva for the curated catalog, a source id for a user-added source.

    sourceKindCatalogSourceKindrequired

    curated: Hoserva's own catalog. user_added: a source URL the user added.

    Possible values: [curated, user_added]

    signedbooleanrequired

    The source's badge as data: true only when the source's installed archive passed a signature check. False for every entry of an unsigned user-added source.

    installedbooleanrequired

    A stack of this template id exists.

  • ]
  • lastCheckedAtstring<date-time>

    When the most recent catalog check finished, whatever its outcome. Absent before any check has run since the daemon started.

    lastOutcomeCatalogCheckOutcome

    How a catalog check ended.

    Possible values: [updated, unchanged, failed]

    CatalogList
    {
    "serial": 0,
    "generatedAt": "2024-07-29T15:51:28.071Z",
    "templates": [
    {
    "id": "string",
    "revision": 0,
    "title": "string",
    "categories": [
    "string"
    ],
    "docs": "string",
    "maintainer": "string",
    "description": "string",
    "source": "string",
    "sourceKind": "curated",
    "signed": true,
    "installed": true
    }
    ],
    "lastCheckedAt": "2024-07-29T15:51:28.071Z",
    "lastOutcome": "updated"
    }