Skip to main content

InstalledRelease

Display identity of the signed release an installation has selected.

Read from that release's staged metadata, which was verified when it was staged and is private to the manager's owner. It names what is installed; it grants nothing and is never used for a trust or compatibility decision.

bundle_idBundle Id (string)required

Signed capability bundle identifier, such as foxlight.video-studio.

Possible values: non-empty and <= 128 characters

title object

Human-readable bundle title from the signed manifest, when it declares one.

anyOf
string

Possible values: non-empty and <= 128 characters

bundle_versionBundle Version (string)required

Bundle version from the signed manifest.

Possible values: non-empty and <= 64 characters

publisherPublisher (string)required

Identifier of the publisher that signed the release.

Possible values: non-empty and <= 64 characters

sequenceSequence (integer)required

The publisher's increasing release sequence number.

Possible values: >= 1

registration object

Selected metadata's capability contracts and declared requirements; absent when unavailable. This is not live readiness or execution authority.

anyOf
capabilities object[]required

Installed operation purposes, versions and contract digests. Full schemas require an exact-capability read.

Possible values: <= 8

  • Array [
    • qualified_idQualified Id (string)required

    Declared id@version.

    Possible values: <= 256 characters

    revisionRevision (string)required

    Exact descriptor digest.

    Possible values: Value must match regular expression ^[a-f0-9]{16}$

    titleTitle (string)required

    Bounded declared title.

    Possible values: <= 128 characters

    purposePurpose (string)required

    Bounded declared purpose, possibly shortened.

    Possible values: <= 256 characters

    io_modeIo Mode (string)required

    Declared invocation media contract.

    Possible values: [unary, server_streaming, client_streaming, bidirectional]

  • ]
    • skulk_requiresSkulk Requires (string)required

    Declared Skulk version range.

    Possible values: <= 128 characters

    python_requiresPython Requires (string)required

    Declared Python version range.

    Possible values: <= 128 characters

    platformsstring[]required

    Declared runtime platforms.

    Possible values: <= 2

    configuration_requiredConfiguration Required (boolean)

    Whether the installed manifest declares ordinary configuration.

    Default value: false
    required_credential_idsstring[]

    Declared required credential identifiers only; no values, fingerprints, configuration or backend paths.

    Possible values: <= 16

    Default value: []
    InstalledRelease
    {
      "bundle_id": "string",
      "title": "string",
      "bundle_version": "string",
      "publisher": "string",
      "sequence": 0,
      "registration": {
        "capabilities": [
          {
            "qualified_id": "string",
            "revision": "string",
            "title": "string",
            "purpose": "string",
            "io_mode": "unary"
          }
        ],
        "skulk_requires": "string",
        "python_requires": "string",
        "platforms": [
          "string"
        ],
        "configuration_required": false,
        "required_credential_ids": [
          "string"
        ]
      }
    }