artifactReadRequestSchema

const artifactReadRequestSchema: object

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

Type Declaration

$id

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

$schema

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

additionalProperties

readonly additionalProperties: true

description

readonly description: "A ranged read of an engine-owned media artifact through IndeRunApi.readArtifact (ADR 017). Reads are repeatable until the artifact is disposed; each returns at most the engine's configured maximum read size, which bounds what one call -- and one bridge message -- carries."

properties

readonly properties: object

properties.artifactId

readonly artifactId: object

properties.artifactId.description

readonly description: "MediaArtifact.id of the artifact to read."

properties.artifactId.minLength

readonly minLength: 1

properties.artifactId.type

readonly type: "string"

properties.maxBytes

readonly maxBytes: object

properties.maxBytes.description

readonly description: "Most bytes to return. Absent, or larger than the engine's maximum read size, means that maximum."

properties.maxBytes.minimum

readonly minimum: 1

properties.maxBytes.type

readonly type: "integer"

properties.offset

readonly offset: object

properties.offset.description

readonly description: "Byte offset to read from. Absent means 0. An offset equal to the artifact's size returns an empty, final chunk; a larger one is rejected."

properties.offset.minimum

readonly minimum: 0

properties.offset.type

readonly type: "integer"

required

readonly required: readonly ["artifactId"]

title

readonly title: "ArtifactReadRequest"

type

readonly type: "object"