io.agent.release Documentation (EN)

main record

A record representing a software release.

Record Key string

Properties

assets array of ref #asset Optional

List of download links associated with this release.

createdAt string datetime Required

Date and time the release was published.

dependencies array of ref #dependency Optional

The software dependencies of this release.

details string uri Optional

A link to a human-readable page with more details about the release.

name string Required

The name or identifier of the software.

maxLength: 100 bytes

notes string markdown Optional

Release notes.

maxLength: 3000 bytes

version string Required

The semantic version string, e.g., 1.2.0-beta.1

maxLength: 50 bytes

View raw schema

{
  "key": "string",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "name",
      "version",
      "createdAt"
    ],
    "properties": {
      "name": {
        "type": "string",
        "maxLength": 100,
        "description": "The name or identifier of the software."
      },
      "notes": {
        "type": "string",
        "format": "markdown",
        "maxLength": 3000,
        "description": "Release notes."
      },
      "assets": {
        "type": "array",
        "items": {
          "ref": "#asset",
          "type": "ref"
        },
        "description": "List of download links associated with this release."
      },
      "details": {
        "type": "string",
        "format": "uri",
        "description": "A link to a human-readable page with more details about the release."
      },
      "version": {
        "type": "string",
        "maxLength": 50,
        "description": "The semantic version string, e.g., 1.2.0-beta.1"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "Date and time the release was published."
      },
      "dependencies": {
        "type": "array",
        "items": {
          "ref": "#dependency",
          "type": "ref"
        },
        "description": "The software dependencies of this release."
      }
    }
  },
  "description": "A record representing a software release."
}

asset object

A link to a downloadable asset associated with a release.

Properties

name string Required

Name of the asset.

Known values: linux_amd64, linux_arm64, darwin_arm64

sha256 string Optional

SHA-256 checksum.

url string uri Required

Direct download link.

View raw schema

{
  "type": "object",
  "required": [
    "name",
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "description": "Direct download link."
    },
    "name": {
      "type": "string",
      "description": "Name of the asset.",
      "knownValues": [
        "linux_amd64",
        "linux_arm64",
        "darwin_arm64"
      ]
    },
    "sha256": {
      "type": "string",
      "description": "SHA-256 checksum."
    }
  },
  "description": "A link to a downloadable asset associated with a release."
}

dependency object

A software dependency of the release

Properties

name string Required

The name of the dependency

version string Required

The version of the dependency

View raw schema

{
  "type": "object",
  "required": [
    "name",
    "version"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the dependency"
    },
    "version": {
      "type": "string",
      "description": "The version of the dependency"
    }
  },
  "description": "A software dependency of the release"
}