mediaArtifactSchema

const mediaArtifactSchema: object

The JSON Schemas those models were generated from, for runtime use.

Type Declaration

$id

readonly $id: "https://schemas.inderun.dev/1.0/media-artifact.schema.json"

$schema

readonly $schema: "https://json-schema.org/draft/2020-12/schema"

additionalProperties

readonly additionalProperties: true

description

readonly description: "A reference to retrievable media a run produced (ADR 017). It carries no bytes and no location: an engine-owned artifact is read through the engine by id, and an application-owned one was written to an application destination. Media-neutral: audio, images and video share this shape and differ only in mediaType."

properties

readonly properties: object

properties.byteLength

readonly byteLength: object

properties.byteLength.description

readonly description: "Size of the media in bytes. Always set for an artifact the engine materialized."

properties.byteLength.minimum

readonly minimum: 0

properties.byteLength.type

readonly type: "integer"

properties.destinationRef

readonly destinationRef: object

properties.destinationRef.description

readonly description: "The request's delivery.destinationRef the bytes were written to. Set exactly when owner is 'application'."

properties.destinationRef.minLength

readonly minLength: 1

properties.destinationRef.type

readonly type: "string"

properties.durationMs

readonly durationMs: object

properties.durationMs.description

readonly description: "Duration of time-based media in milliseconds, where the producer knows it."

properties.durationMs.minimum

readonly minimum: 0

properties.durationMs.type

readonly type: "number"

properties.id

readonly id: object

properties.id.description

readonly description: "Opaque, engine-issued identifier. Never a path, URL or provider identifier."

properties.id.minLength

readonly minLength: 1

properties.id.type

readonly type: "string"

properties.lifetime

readonly lifetime: object

properties.lifetime.description

readonly description: "How long the engine keeps the bytes. 'until_disposed': until the application disposes the artifact or the process ends; the artifact outlives the run that produced it."

properties.lifetime.enum

readonly enum: readonly ["until_disposed"]

properties.lifetime.title

readonly title: "ArtifactLifetime"

properties.mediaType

readonly mediaType: object

properties.mediaType.description

readonly description: "IANA media type of the bytes, e.g. 'audio/wav'. Encoding parameters ride on the media type (e.g. 'audio/L16;rate=22050')."

properties.mediaType.minLength

readonly minLength: 1

properties.mediaType.type

readonly type: "string"

properties.owner

readonly owner: object

properties.owner.description

readonly description: "'engine': the engine holds the bytes and the application reads them by id until it disposes the artifact. 'application': the bytes were written to the application destination named by destinationRef and the engine holds nothing."

properties.owner.enum

readonly enum: readonly ["engine", "application"]

properties.owner.title

readonly title: "ArtifactOwner"

required

readonly required: readonly ["id", "mediaType", "owner", "lifetime"]

title

readonly title: "MediaArtifact"

type

readonly type: "object"