ItemReadOutputResult

item/readOutput result: one stored-byte page.

Fields and variants

• byteLen
• content
• encoding
• eof
• mediaType
• offsetBytes

Source

schema/msp/experimental/msp.schema.json#/types/ItemReadOutputResult

{
  "description": "`item/readOutput` result: one stored-byte page.",
  "properties": {
    "byteLen": {
      "description": "STORED bytes served in THIS response (not the output's total; that is\n`outputRef.byteLen` on the item). The next page's `offsetBytes` is\n`offsetBytes + byteLen` — short-serving and advancing are separate,\nso paging never skips or double-reads a byte.",
      "type": "integer"
    },
    "content": {
      "description": "The served range, decoded per `encoding`.",
      "type": "string"
    },
    "encoding": {
      "$ref": "#/$defs/ItemReadOutputEncoding",
      "description": "How `content` encodes the stored bytes."
    },
    "eof": {
      "description": "`true` when this range reached the end of the stored output.",
      "type": "boolean"
    },
    "mediaType": {
      "description": "The stored output's media type (e.g. `text/plain`).",
      "type": "string"
    },
    "offsetBytes": {
      "description": "The STORED-byte offset this response actually served from.",
      "type": "integer"
    }
  },
  "required": [
    "byteLen",
    "content",
    "encoding",
    "eof",
    "mediaType",
    "offsetBytes"
  ],
  "type": "object"
}