io.agent.release

agent.io

Documentation

A record representing a software release.

main record

A record representing a software release.

Record Key tid Timestamp-based ID

Properties

assets array of ref #asset Optional

List of download links associated with this release.

changes ref #changes Optional

Changelog entries for 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.

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., v1.2.0-beta.1

maxLength: 50 bytes
View raw schema 
{
  "key": "tid",
  "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."
      },
      "changes": {
        "ref": "#changes",
        "type": "ref",
        "description": "Changelog entries for this release."
      },
      "version": {
        "type": "string",
        "maxLength": 50,
        "description": "The semantic version string, e.g., v1.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 (e.g., macos-x64, source-code).

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 (e.g., macos-x64, source-code)."
    },
    "sha256": {
      "type": "string",
      "description": "SHA-256 checksum."
    }
  },
  "description": "A link to a downloadable asset associated with a release."
}
changes object

Changelog entries for a release, informed by https://keepachangelog.com/en/1.1.0/.

Properties

added array of stringmarkdown Optional

New features.

deprecated array of stringmarkdown Optional

Deprecations.

fixed array of stringmarkdown Optional

Fixed bugs.

modified array of stringmarkdown Optional

Modifications of existing features.

removed array of stringmarkdown Optional

Removed features.

security array of stringmarkdown Optional

Security updates.

View raw schema 
{
  "type": "object",
  "properties": {
    "added": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "markdown",
        "maxLength": 1000
      },
      "description": "New features."
    },
    "fixed": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "markdown",
        "maxLength": 1000
      },
      "description": "Fixed bugs."
    },
    "removed": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "markdown",
        "maxLength": 1000
      },
      "description": "Removed features."
    },
    "modified": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "markdown",
        "maxLength": 1000
      },
      "description": "Modifications of existing features."
    },
    "security": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "markdown",
        "maxLength": 1000
      },
      "description": "Security updates."
    },
    "deprecated": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "markdown",
        "maxLength": 1000
      },
      "description": "Deprecations."
    }
  },
  "description": "Changelog entries for a release, informed by https://keepachangelog.com/en/1.1.0/."
}
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"
}

Lexicon Garden

@