Texecom Event Schemas

JSON Schema Documentation

Media Object Ready Payload

Emitted when an uploaded media object has been processed (pending -> ready) and its renditions can be served through media-service's signed URLs. Published in the same transaction as the status change.

$idhttps://schemas.texecom-prod.com/v2/events/payload/service/media/object/ready/v1.0.0.json
$schemahttp://json-schema.org/draft-07/schema

Properties

NameType
mediaIdString
ownerAccountIdString
kindString
sizesArray

mediaId

Description UUID of the media object (media.objects.id). Also the envelope's sourceDetails[0].guid.
TypeString
Required Yes
Format uuid

ownerAccountId

Description UUID of the identity account that owns the object (media.objects.owner_account_id).
TypeString
Required Yes
Format uuid

kind

Description Media kind (media.objects.kind), e.g. avatar. Kinds are media-service configuration, so a new kind is not a schema change.
TypeString
Required Yes
Min Length 1

sizes

Description Edge lengths in pixels of the square WebP renditions now servable, in ascending order.
TypeArray
Required Yes
Unique Items true
Min Items 1

Schema

{
    "$id": "https://schemas.texecom-prod.com/v2/events/payload/service/media/object/ready/v1.0.0.json",
    "$schema": "http://json-schema.org/draft-07/schema",
    "title": "Media Object Ready Payload",
    "description": "Emitted when an uploaded media object has been processed (pending -> ready) and its renditions can be served through media-service's signed URLs. Published in the same transaction as the status change.",
    "type": "object",
    "properties": {
        "mediaId": {
            "description": "UUID of the media object (media.objects.id). Also the envelope's sourceDetails[0].guid.",
            "type": "string",
            "format": "uuid"
        },
        "ownerAccountId": {
            "description": "UUID of the identity account that owns the object (media.objects.owner_account_id).",
            "type": "string",
            "format": "uuid"
        },
        "kind": {
            "description": "Media kind (media.objects.kind), e.g. avatar. Kinds are media-service configuration, so a new kind is not a schema change.",
            "type": "string",
            "minLength": 1
        },
        "sizes": {
            "description": "Edge lengths in pixels of the square WebP renditions now servable, in ascending order.",
            "type": "array",
            "items": {
                "type": "integer",
                "minimum": 1
            },
            "minItems": 1,
            "uniqueItems": true
        }
    },
    "required": [
        "mediaId",
        "ownerAccountId",
        "kind",
        "sizes"
    ],
    "additionalProperties": false
}