repository
stringclasses 528
values | commit
stringlengths 40
40
| commitDate
timestamp[s] | path
stringlengths 11
149
| repoStars
int64 5
94.9k
| repoLastFetched
stringclasses 528
values | content
stringlengths 48
736k
| license
stringclasses 14
values | language
stringclasses 7
values |
|---|---|---|---|---|---|---|---|---|
LottieFiles/lottie-docs | bc9a3f40c7bbf65091fcc23505f5e641bd1e6527 | 2022-07-09T16:10:00 | docs/schema/shapes/stroke-dash.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/helpers/visual-object"
},
{
"properties": {
"n": {
"$ref": "#/$defs/constants/stroke-dash-type",
"default": "d",
"title": "Dash Type"
},
"v": {
"$ref": "#/$defs/animated-properties/value",
"description": "Length of the dash",
"title": "Length"
}
},
"required": [],
"type": "object"
}
],
"description": "An item used to described the dashe pattern in a stroked path",
"title": "Stroke Dash",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | d301bfaaea449b0328d9a4ab58b3a1705b1787dc | 2021-10-23T12:05:07 | docs/schema/shapes/gradient-stroke.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/shapes/shape-element"
},
{
"$ref": "#/$defs/shapes/base-stroke"
},
{
"$ref": "#/$defs/shapes/gradient"
},
{
"properties": {
"ty": {
"const": "gs",
"title": "Shape Type",
"type": "string"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "Gradient stroke",
"title": "Gradient Stroke",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 837607e8c9b559b972ec0a23ff635fd5a5c59aa9 | 2021-10-18T11:25:08 | docs/schema/effects/tint-effect.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/effects/effect"
},
{
"properties": {
"ty": {
"const": 20,
"title": "Type",
"type": "integer"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "Colorizes the layer\n@note Opacity is in [0, 100]",
"title": "Tint Effect",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 58ded472e45867cf164ea2fcc91bad061cb88224 | 2022-06-20T14:24:59 | docs/schema/shapes/repeater.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/shapes/modifier"
},
{
"properties": {
"c": {
"$ref": "#/$defs/animated-properties/value",
"title": "Copies"
},
"m": {
"$ref": "#/$defs/constants/composite",
"default": 1,
"title": "Composite"
},
"o": {
"$ref": "#/$defs/animated-properties/value",
"title": "Offset"
},
"tr": {
"$ref": "#/$defs/shapes/repeater-transform",
"title": "Transform"
},
"ty": {
"const": "rp",
"title": "Shape Type",
"type": "string"
}
},
"required": [
"ty",
"c",
"tr"
],
"type": "object"
}
],
"caniuse": "shape-repeater",
"description": "Duplicates previous shapes in a group",
"title": "Repeater",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 58ded472e45867cf164ea2fcc91bad061cb88224 | 2022-06-20T14:24:59 | docs/schema/effects/pro-levels-effect.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/effects/effect"
},
{
"properties": {
"ef": {
"prefixItems": [
{
"$ref": "#/$defs/effect-values/drop-down",
"title": "00"
},
{
"$ref": "#/$defs/effect-values/no-value",
"title": "01"
},
{
"$ref": "#/$defs/effect-values/no-value",
"title": "02"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "comp_inblack"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "comp_inwhite"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "comp_gamma"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "comp_outblack"
},
{
"$ref": "#/$defs/effect-values/no-value",
"title": "comp_outwhite"
},
{
"$ref": "#/$defs/effect-values/no-value",
"title": "08"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "09"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "r_inblack"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "r_inwhite"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "r_gamma"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "r_outblack"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "r_outwhite"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "15"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "16"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "g_inblack"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "g_inwhite"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "g_gamma"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "g_outblack"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "g_outwhite"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "22"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "23"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "b_inblack"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "b_inwhite"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "b_gamma"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "b_outblack"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "b_outwhite"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "29"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "a_inblack"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "a_inwhite"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "a_gamma"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "a_outblack"
},
{
"$ref": "#/$defs/effect-values/no-value",
"title": "a_outwhite"
}
],
"title": "Effect values",
"type": "array"
},
"ty": {
"const": 24,
"title": "Type",
"type": "integer"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"caniuse": "effect-color-levels-individual-controls",
"description": "",
"title": "Pro Levels Effect",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 26b55e254e7d2c25c0795377ab12f325db68e90d | 2022-06-25T14:49:31 | docs/schema/shapes/stroke.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/shapes/shape-element"
},
{
"$ref": "#/$defs/shapes/base-stroke"
},
{
"properties": {
"c": {
"$ref": "#/$defs/animated-properties/color-value",
"title": "Color"
},
"ty": {
"const": "st",
"title": "Shape Type",
"type": "string"
}
},
"required": [
"ty",
"c"
],
"type": "object"
}
],
"caniuse": "shape-stroke",
"description": "Solid stroke",
"title": "Stroke",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 26e06cd7aa758ae68e95cc4b0b97c64571411b86 | 2022-11-01T09:29:58 | docs/schema/text/text-alignment-options.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"properties": {
"a": {
"$ref": "#/$defs/animated-properties/multi-dimensional",
"caniuse": "animators-grouping-alignment",
"description": "Group alignment",
"title": "Alignment"
},
"g": {
"$ref": "#/$defs/constants/text-grouping",
"caniuse": "animators-anchor-point-grouping",
"description": "Anchor point grouping",
"title": "Grouping"
}
},
"required": [],
"type": "object"
}
],
"description": "",
"title": "Text Alignment Options",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 9b039d896c6016aaa1932ecd8f260e55f6b0b7ca | 2021-10-19T06:04:07 | docs/schema/shapes/repeater.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/shapes/modifier"
},
{
"properties": {
"c": {
"$ref": "#/$defs/animated-properties/value",
"title": "Copies"
},
"m": {
"$ref": "#/$defs/constants/composite",
"default": 1,
"title": "Composite"
},
"o": {
"$ref": "#/$defs/animated-properties/value",
"title": "Offset"
},
"tr": {
"$ref": "#/$defs/shapes/repeater-transform",
"title": "Transform"
},
"ty": {
"const": "rp",
"title": "Type",
"type": "string"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "Duplicates previous shapes in a group",
"title": "Repeater",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | d301bfaaea449b0328d9a4ab58b3a1705b1787dc | 2021-10-23T12:05:07 | docs/schema/shapes/trim.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/shapes/modifier"
},
{
"properties": {
"e": {
"$ref": "#/$defs/animated-properties/value",
"title": "End"
},
"m": {
"$ref": "#/$defs/constants/trim-multiple-shapes",
"title": "Multiple"
},
"o": {
"$ref": "#/$defs/animated-properties/value",
"title": "Offset"
},
"s": {
"$ref": "#/$defs/animated-properties/value",
"title": "Start"
},
"ty": {
"const": "tm",
"title": "Shape Type",
"type": "string"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "Trims shapes into a segment",
"title": "Trim",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 26e06cd7aa758ae68e95cc4b0b97c64571411b86 | 2022-11-01T09:29:58 | docs/schema/text/text-style.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/helpers/transform"
},
{
"properties": {
"bl": {
"$ref": "#/$defs/animated-properties/value",
"caniuse": "text-animators-blur",
"title": "Blur"
},
"fb": {
"$ref": "#/$defs/animated-properties/value",
"title": "Fill Brightness"
},
"fc": {
"$ref": "#/$defs/animated-properties/color-value",
"title": "Fill Color"
},
"fh": {
"$ref": "#/$defs/animated-properties/value",
"title": "Fill Hue"
},
"fo": {
"$ref": "#/$defs/animated-properties/value",
"title": "Fill Opacity"
},
"fs": {
"$ref": "#/$defs/animated-properties/value",
"title": "Fill Saturation"
},
"ls": {
"$ref": "#/$defs/animated-properties/value",
"title": "Line Spacing"
},
"sb": {
"$ref": "#/$defs/animated-properties/value",
"title": "Stroke Brightness"
},
"sc": {
"$ref": "#/$defs/animated-properties/color-value",
"title": "Stroke Color"
},
"sh": {
"$ref": "#/$defs/animated-properties/value",
"title": "Stroke Hue"
},
"so": {
"$ref": "#/$defs/animated-properties/value",
"title": "Stroke Opacity"
},
"ss": {
"$ref": "#/$defs/animated-properties/value",
"title": "Stroke Saturation"
},
"sw": {
"$ref": "#/$defs/animated-properties/value",
"title": "Stroke Width"
},
"t": {
"$ref": "#/$defs/animated-properties/value",
"title": "Letter Spacing"
}
},
"required": [],
"type": "object"
}
],
"description": "",
"title": "Text Style",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 5a455049fcd3a4734aeea9d182232e47b17b2916 | 2021-10-25T18:55:59 | docs/schema/shapes/rectangle.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/shapes/shape"
},
{
"properties": {
"p": {
"$ref": "#/$defs/animated-properties/multi-dimensional",
"description": "Center of the rectangle",
"title": "Position"
},
"r": {
"$ref": "#/$defs/animated-properties/value",
"title": "Rounded"
},
"s": {
"$ref": "#/$defs/animated-properties/multi-dimensional",
"title": "Size"
},
"ty": {
"const": "rc",
"title": "Shape Type",
"type": "string"
}
},
"required": [
"ty",
"s",
"p"
],
"type": "object"
}
],
"description": "A simple rectangle shape",
"title": "Rectangle",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | d72684c8bb79cf7770501192abcead358141d812 | 2021-10-19T22:45:29 | docs/schema/animation/animation.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/helpers/visual-object"
},
{
"$ref": "#/$defs/animation/composition"
},
{
"properties": {
"assets": {
"items": {
"$ref": "#/$defs/assets/asset"
},
"title": "Assets",
"type": "array"
},
"chars": {
"description": "Data defining text characters as lottie shapes",
"items": {
"$ref": "#/$defs/text/character-data"
},
"title": "Chars",
"type": "array"
},
"ddd": {
"$ref": "#/$defs/types/int-boolean",
"default": 0,
"title": "Threedimensional"
},
"fonts": {
"$ref": "#/$defs/text/font-list",
"title": "Fonts"
},
"fr": {
"default": 60,
"description": "Framerate in frames per second",
"title": "Framerate",
"type": "number"
},
"h": {
"default": 512,
"title": "Height of the animation",
"type": "integer"
},
"ip": {
"default": 0,
"description": "\"In Point\", which frame the animation starts at (usually 0)",
"title": "In Point",
"type": "number"
},
"meta": {
"$ref": "#/$defs/animation/metadata",
"description": "Document metadata"
},
"op": {
"default": 60,
"description": "\"Out Point\", which frame the animation stops/loops at, which makes this the duration in frames when `ip` is 0",
"title": "Out Point",
"type": "number"
},
"v": {
"default": "5.5.2",
"title": "Version",
"type": "string"
},
"w": {
"default": 512,
"title": "Width of the animation",
"type": "integer"
}
},
"required": [
"w",
"h",
"fr",
"layers",
"op"
],
"type": "object"
}
],
"description": "Top level object, describing the animation",
"title": "Animation",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 837607e8c9b559b972ec0a23ff635fd5a5c59aa9 | 2021-10-18T11:25:08 | docs/schema/constants/line-join.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "",
"oneOf": [
{
"const": 1,
"title": "Miter"
},
{
"const": 2,
"title": "Round"
},
{
"const": 3,
"title": "Bevel"
}
],
"title": "LineJoin",
"type": "integer"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 837607e8c9b559b972ec0a23ff635fd5a5c59aa9 | 2021-10-18T11:25:08 | docs/schema/constants/text-based.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "",
"oneOf": [
{
"const": 1,
"title": "Characters"
},
{
"const": 2,
"title": "Character Excluding Spaces"
},
{
"const": 3,
"title": "Words"
},
{
"const": 4,
"title": "Lines"
}
],
"title": "TextBased",
"type": "integer"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 718213e5e7f2fb9f87829f70a6593b4d739e43eb | 2021-10-26T07:06:57 | docs/schema/animated-properties/keyframe.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"if": {
"properties": {
"h": {
"const": 0
}
}
},
"then": {
"properties": {
"i": {
"$ref": "#/$defs/animated-properties/keyframe-bezier-handle",
"description": "Easing tangent going into the next keyframe",
"title": "In Tangent"
},
"o": {
"$ref": "#/$defs/animated-properties/keyframe-bezier-handle",
"description": "Easing tangent leaving the current keyframe",
"title": "Out Tangent"
}
}
}
}
],
"description": "",
"properties": {
"h": {
"$ref": "#/$defs/helpers/int-boolean",
"default": 0,
"title": "Hold"
},
"s": {
"description": "Value at this keyframe. Note the if the property is a scalar, keyframe values are still represented as arrays",
"items": {
"type": "number"
},
"title": "Value",
"type": "array"
},
"t": {
"default": 0,
"title": "Time",
"type": "number"
}
},
"required": [
"t",
"s"
],
"title": "Keyframe",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 9b039d896c6016aaa1932ecd8f260e55f6b0b7ca | 2021-10-19T06:04:07 | docs/schema/animated-properties/animated-property.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"if": {
"properties": {
"a": {
"const": 1
}
}
},
"then": {
"properties": {
"k": {
"description": "Array of keyframes",
"items": {
"$ref": "#/$defs/animated-properties/keyframe"
},
"title": "Animated Value",
"type": "array"
}
}
}
}
],
"description": "An animatable property that holds an array of numbers",
"properties": {
"a": {
"$ref": "#/$defs/types/int-boolean",
"default": 0,
"title": "Animated"
},
"ix": {
"title": "Property Index",
"type": "integer"
}
},
"title": "Multi Dimensional",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 60369b88e3c4533a96311eb3a2261405623d9653 | 2022-04-10T05:27:44 | docs/schema/constants/trim-multiple-shapes.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "How to handle multiple shapes in trim path",
"oneOf": [
{
"const": 1,
"title": "Individually"
},
{
"const": 2,
"title": "Simultaneously"
}
],
"title": "TrimMultipleShapes",
"type": "integer"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | a330dc23e69c9a43e108db57890902a6383d9da2 | 2021-10-27T07:34:28 | docs/schema/effect-values/angle.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/effect-values/effect-value"
},
{
"properties": {
"ty": {
"const": 1,
"title": "Type",
"type": "integer"
},
"v": {
"$ref": "#/$defs/animated-properties/value",
"title": "Value"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "",
"title": "Effect Value Angle",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 5a455049fcd3a4734aeea9d182232e47b17b2916 | 2021-10-25T18:55:59 | docs/schema/shapes/stroke.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/shapes/shape-element"
},
{
"$ref": "#/$defs/shapes/base-stroke"
},
{
"properties": {
"c": {
"$ref": "#/$defs/animated-properties/multi-dimensional",
"title": "Color"
},
"ty": {
"const": "st",
"title": "Shape Type",
"type": "string"
}
},
"required": [
"ty",
"c"
],
"type": "object"
}
],
"description": "Solid stroke",
"title": "Stroke",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 837607e8c9b559b972ec0a23ff635fd5a5c59aa9 | 2021-10-18T11:25:08 | docs/schema/shapes/gradient-stroke.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/shapes/shape-element"
},
{
"$ref": "#/shapes/base-stroke"
},
{
"$ref": "#/shapes/gradient"
},
{
"properties": {
"ty": {
"const": "gs",
"title": "Type",
"type": "string"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "Gradient stroke",
"title": "Gradient Stroke",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 1b99ae41c2af3820681dd01de475a5ec47b158a9 | 2021-10-20T18:11:18 | docs/schema/animation/composition.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Base class for layer holders",
"properties": {
"layers": {
"items": {
"$ref": "#/$defs/layers/concrete-layer"
},
"title": "Layers",
"type": "array"
}
},
"required": [
"layers"
],
"title": "Composition",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 8362bdd4ad1eaef21e98f05d78b011c64ef57fbb | 2021-10-22T09:59:40 | docs/schema/layers/layer.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/helpers/visual-object"
},
{
"properties": {
"ao": {
"$ref": "#/$defs/types/int-boolean",
"default": 0,
"title": "Auto Orient"
},
"bm": {
"$ref": "#/$defs/constants/blend-mode",
"default": 0,
"title": "Blend Mode"
},
"cl": {
"description": "CSS class used by the SVG renderer",
"title": "Class",
"type": "string"
},
"ddd": {
"$ref": "#/$defs/types/int-boolean",
"default": 0,
"description": "Whether the layer is threedimensional",
"title": "Threedimensional"
},
"ef": {
"items": {
"$ref": "#/$defs/effects/effect"
},
"title": "Effects",
"type": "array"
},
"hasMask": {
"description": "Whether the layer has masks applied",
"title": "Has Masks",
"type": "boolean"
},
"hd": {
"description": "Whether the layer is hidden",
"title": "Hidden",
"type": "boolean"
},
"ind": {
"title": "Index",
"type": "integer"
},
"ip": {
"description": "Frame when the layers becomes visible",
"title": "In Point",
"type": "number"
},
"ks": {
"$ref": "#/$defs/helpers/transform",
"description": "Layer transform",
"title": "Transform"
},
"ln": {
"description": "`id` attribute used by the SVG renderer",
"title": "Layer XML ID",
"type": "string"
},
"masksProperties": {
"items": {
"$ref": "#/$defs/helpers/mask"
},
"title": "Masks",
"type": "array"
},
"op": {
"description": "Frame when the layers becomes invisible",
"title": "Out Point",
"type": "number"
},
"parent": {
"description": "Must be the `ind` property of another layer",
"title": "Parent Index",
"type": "integer"
},
"sr": {
"default": 1,
"title": "Time Stretch",
"type": "number"
},
"st": {
"default": 0,
"title": "Start Time",
"type": "number"
},
"td": {
"title": "Matte Target",
"type": "integer"
},
"tt": {
"$ref": "#/$defs/constants/matte-mode",
"title": "Matte Mode"
},
"ty": {
"description": "Layer Type",
"oneOf": [
{
"const": 0,
"title": "Precomposition layer"
},
{
"const": 1,
"title": "Solid color layer"
},
{
"const": 2,
"title": "Image layer"
},
{
"const": 3,
"title": "Null layer"
},
{
"const": 4,
"title": "Shape layer"
},
{
"const": 5,
"title": "Text layer"
},
{
"const": 6,
"title": "Audio layer"
},
{
"const": 7,
"title": "Video placeholder"
},
{
"const": 8,
"title": "Image sequence"
},
{
"const": 9,
"title": "Video layer"
},
{
"const": 10,
"title": "Image placeholder"
},
{
"const": 11,
"title": "Guide layer"
},
{
"const": 12,
"title": "Adjustment layer"
},
{
"const": 13,
"title": "Camera"
},
{
"const": 14,
"title": "Light layer"
}
],
"title": "Type",
"type": "integer"
}
},
"required": [
"ty",
"st",
"ip",
"op",
"ks"
],
"type": "object"
}
],
"description": "",
"title": "Layer",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 48d8feb1f07379ebfe51f97f9b548566ee4a3193 | 2022-10-13T05:38:12 | docs/schema/effects/effect.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/helpers/visual-object"
},
{
"properties": {
"ef": {
"items": {
"oneOf": [
{
"$ref": "#/$defs/effect-values/no-value"
},
{
"$ref": "#/$defs/effect-values/angle"
},
{
"$ref": "#/$defs/effect-values/checkbox"
},
{
"$ref": "#/$defs/effect-values/color"
},
{
"$ref": "#/$defs/effect-values/drop-down"
},
{
"$ref": "#/$defs/effect-values/ignored"
},
{
"$ref": "#/$defs/effect-values/layer"
},
{
"$ref": "#/$defs/effect-values/point"
},
{
"$ref": "#/$defs/effect-values/slider"
}
]
},
"title": "Effect Values",
"type": "array"
},
"en": {
"$ref": "#/$defs/helpers/int-boolean",
"default": 1,
"title": "Enabled"
},
"ix": {
"title": "Effect Index",
"type": "integer"
},
"ty": {
"description": "Effect type",
"title": "Type",
"type": "integer"
}
},
"required": [
"ty",
"ef"
],
"type": "object"
}
],
"caniuse": "effects",
"description": "Layer effect",
"title": "Effect",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 837607e8c9b559b972ec0a23ff635fd5a5c59aa9 | 2021-10-18T11:25:08 | docs/schema/shapes/repeater.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/shapes/modifier"
},
{
"properties": {
"c": {
"$ref": "#/properties/value",
"title": "Copies"
},
"m": {
"$ref": "#/constants/composite",
"default": 1,
"title": "Composite"
},
"o": {
"$ref": "#/properties/value",
"title": "Offset"
},
"tr": {
"$ref": "#/shapes/repeater-transform",
"title": "Transform"
},
"ty": {
"const": "rp",
"title": "Type",
"type": "string"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "Duplicates previous shapes in a group",
"title": "Repeater",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 5a455049fcd3a4734aeea9d182232e47b17b2916 | 2021-10-25T18:55:59 | docs/schema/assets/image.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/assets/asset"
},
{
"properties": {
"e": {
"$ref": "#/$defs/helpers/int-boolean",
"default": 0,
"description": "Whether the image is embedded",
"title": "Embedded"
},
"h": {
"default": 0,
"description": "Height of the image",
"title": "Height",
"type": "number"
},
"p": {
"default": "",
"description": "Image filename",
"title": "File name",
"type": "string"
},
"u": {
"default": "",
"description": "Path to the directory containing an image",
"title": "Path",
"type": "string"
},
"w": {
"default": 0,
"description": "Width of the image",
"title": "Width",
"type": "number"
}
},
"required": [
"p"
],
"type": "object"
}
],
"description": "External image",
"title": "Image",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 5a455049fcd3a4734aeea9d182232e47b17b2916 | 2021-10-25T18:55:59 | docs/schema/animated-properties/animated-property.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"if": {
"properties": {
"a": {
"const": 1
}
}
},
"then": {
"properties": {
"k": {
"description": "Array of keyframes",
"items": {
"$ref": "#/$defs/animated-properties/keyframe"
},
"title": "Animated Value",
"type": "array"
}
}
}
}
],
"description": "An animatable property that holds an array of numbers",
"properties": {
"a": {
"$ref": "#/$defs/helpers/int-boolean",
"default": 0,
"description": "Whether the property is animated",
"title": "Animated"
},
"ix": {
"title": "Property Index",
"type": "integer"
},
"x": {
"title": "Expression",
"type": "string"
}
},
"required": [
"k"
],
"title": "Multi Dimensional",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 9b039d896c6016aaa1932ecd8f260e55f6b0b7ca | 2021-10-19T06:04:07 | docs/schema/shapes/gradient.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"properties": {
"a": {
"$ref": "#/$defs/animated-properties/value",
"title": "Highlight Angle"
},
"e": {
"$ref": "#/$defs/animated-properties/multi-dimensional",
"title": "End Point"
},
"g": {
"$ref": "#/$defs/animated-properties/gradient-colors",
"title": "Colors"
},
"h": {
"$ref": "#/$defs/animated-properties/value",
"title": "Highlight Length"
},
"s": {
"$ref": "#/$defs/animated-properties/multi-dimensional",
"title": "Start Point"
},
"t": {
"$ref": "#/$defs/constants/gradient-type",
"default": 1,
"title": "Gradient Type"
}
},
"required": [],
"type": "object"
}
],
"description": "",
"title": "Gradient",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 9b039d896c6016aaa1932ecd8f260e55f6b0b7ca | 2021-10-19T06:04:07 | docs/schema/shapes/trim.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/shapes/modifier"
},
{
"properties": {
"e": {
"$ref": "#/$defs/animated-properties/value",
"title": "End"
},
"m": {
"$ref": "#/$defs/constants/trim-multiple-shapes",
"title": "Multiple"
},
"o": {
"$ref": "#/$defs/animated-properties/value",
"title": "Offset"
},
"s": {
"$ref": "#/$defs/animated-properties/value",
"title": "Start"
},
"ty": {
"const": "tm",
"title": "Type",
"type": "string"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "Trims shapes into a segment",
"title": "Trim",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | baf2dcae570dfd1368ce1dd005cf9bf020f462c2 | 2021-10-31T08:51:52 | docs/schema/animated-properties/split-vector.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "An animatable property that is split into individually anaimated components",
"properties": {
"s": {
"title": "Split",
"type": "boolean"
},
"x": {
"$ref": "#/$defs/animated-properties/value",
"title": "X"
},
"y": {
"$ref": "#/$defs/animated-properties/value",
"title": "X"
},
"z": {
"$ref": "#/$defs/animated-properties/value",
"title": "Z"
}
},
"required": [
"s",
"x",
"y"
],
"title": "Split Vector",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | a330dc23e69c9a43e108db57890902a6383d9da2 | 2021-10-27T07:34:28 | docs/schema/effects/stroke-effect.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/effects/effect"
},
{
"properties": {
"ef": {
"prefixItems": [
{
"$ref": "#/$defs/effect-values/color",
"title": "00"
},
{
"$ref": "#/$defs/effect-values/checkbox",
"title": "01"
},
{
"$ref": "#/$defs/effect-values/checkbox",
"title": "02"
},
{
"$ref": "#/$defs/effect-values/color",
"title": "color"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "04"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "05"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "06"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "07"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "08"
},
{
"$ref": "#/$defs/effect-values/drop-down",
"title": "09"
},
{
"$ref": "#/$defs/effect-values/drop-down",
"title": "type"
}
],
"title": "Effect values",
"type": "array"
},
"ty": {
"const": 22,
"title": "Type",
"type": "integer"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "",
"title": "Stroke Effect",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 3370b30ec4e1018bfb5dcced8c0d885149a03c81 | 2022-07-10T09:42:29 | docs/schema/shapes/zig-zag.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/shapes/shape-element"
},
{
"properties": {
"pt": {
"$ref": "#/$defs/animated-properties/value",
"description": "Number of ridges",
"title": "Frequency"
},
"r": {
"$ref": "#/$defs/animated-properties/value",
"description": "Radius to maked it a smoother curve",
"title": "Roundness"
},
"s": {
"$ref": "#/$defs/animated-properties/value",
"description": "Distance between peaks and troughs",
"title": "Amplitude"
},
"ty": {
"const": "zz",
"title": "Shape Type",
"type": "string"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "Changes the edges of affected shapes into a series of peaks and valleys of uniform size",
"title": "Zig Zags",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | aa5b29ee6d5a596aa4b6123a80a49c5f13cbd81c | 2021-10-18T13:52:26 | docs/schema/text/text-document.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"properties": {
"f": {
"default": "",
"title": "Font Family",
"type": "string"
},
"fc": {
"item": {
"default": [
0,
0,
0
],
"type": "number"
},
"title": "Color",
"type": "array"
},
"j": {
"$ref": "#/constants/text-justify",
"default": 0,
"title": "Justify"
},
"lh": {
"title": "Line Height",
"type": "number"
},
"s": {
"default": 10,
"title": "Font Size",
"type": "number"
},
"sz": {
"item": {
"type": "number"
},
"title": "Wrap Size",
"type": "array"
},
"t": {
"default": "",
"title": "Text",
"type": "string"
}
},
"required": [],
"type": "object"
}
],
"description": "Note that for multi-line text, lines are separated by \\r",
"title": "Text Document",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 6b3835d19cde824a351fcb7073dd9706d2133ebd | 2022-04-11T17:45:33 | docs/schema/shapes/shape-element.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/helpers/visual-object"
},
{
"properties": {
"bm": {
"$ref": "#/$defs/constants/blend-mode",
"title": "Blend Mode"
},
"cix": {
"description": "Index used in expressions",
"title": "Property index",
"type": "integer"
},
"hd": {
"description": "Whether the shape is hidden",
"title": "Hidden",
"type": "boolean"
},
"ix": {
"description": "Index used in expressions",
"title": "Property index",
"type": "integer"
},
"ty": {
"oneOf": [
{
"const": "rc",
"title": "Rectangle"
},
{
"const": "el",
"title": "Ellipse"
},
{
"const": "sr",
"title": "Polygon / Star"
},
{
"const": "sh",
"title": "Path"
},
{
"const": "fl",
"title": "Fill"
},
{
"const": "st",
"title": "Stroke"
},
{
"const": "gf",
"title": "Gradient fill"
},
{
"const": "gs",
"title": "Gradient stroke"
},
{
"const": "gr",
"title": "Group"
},
{
"const": "tr",
"title": "Transform"
},
{
"const": "rd",
"title": "Rounded corners"
},
{
"const": "pb",
"title": "Pucker / bloat"
},
{
"const": "mm",
"title": "Merge"
},
{
"const": "tw",
"title": "Twist"
},
{
"const": "op",
"title": "Offset path"
},
{
"const": "zz",
"title": "Zig zag"
},
{
"const": "rp",
"title": "Repeater"
},
{
"const": "tm",
"title": "Trim"
}
],
"title": "Shape Type",
"type": "string"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "Base class for all elements of ShapeLayer and Group",
"title": "Shape Element",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 8babae8913ba408f931b62f8f7ac4d721a1c1e34 | 2022-04-09T04:47:44 | docs/schema/layers/visual-layer.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/layers/layer"
},
{
"properties": {
"ao": {
"$ref": "#/$defs/helpers/int-boolean",
"default": 0,
"description": "If 1, The layer will rotate itself to match its animated position path",
"title": "Auto Orient"
},
"ef": {
"description": "List of layer effects",
"items": {
"oneOf": [
{
"$ref": "#/$defs/effects/custom-effect"
},
{
"$ref": "#/$defs/effects/drop-shadow-effect"
},
{
"$ref": "#/$defs/effects/fill-effect"
},
{
"$ref": "#/$defs/effects/gaussian-blur-effect"
},
{
"$ref": "#/$defs/effects/matte3-effect"
},
{
"$ref": "#/$defs/effects/pro-levels-effect"
},
{
"$ref": "#/$defs/effects/stroke-effect"
},
{
"$ref": "#/$defs/effects/tint-effect"
},
{
"$ref": "#/$defs/effects/tritone-effect"
},
{
"$ref": "#/$defs/effects/radial-wipe-effect"
},
{
"$ref": "#/$defs/effects/wavy-effect"
},
{
"$ref": "#/$defs/effects/puppet-effect"
},
{
"$ref": "#/$defs/effects/spherize-effect"
},
{
"$ref": "#/$defs/effects/paint-over-transparent-effect"
},
{
"$ref": "#/$defs/effects/mesh-warp-effect"
},
{
"$ref": "#/$defs/effects/displacement-map-effect"
}
]
},
"title": "Effects",
"type": "array"
},
"hasMask": {
"description": "Whether the layer has masks applied",
"title": "Has Masks",
"type": "boolean"
},
"ks": {
"$ref": "#/$defs/helpers/transform",
"description": "Layer transform",
"title": "Transform"
},
"masksProperties": {
"items": {
"$ref": "#/$defs/helpers/mask"
},
"title": "Masks",
"type": "array"
},
"mb": {
"description": "Whether motion blur is enabled for the layer",
"title": "Motion Blur",
"type": "boolean"
},
"td": {
"title": "Matte Target",
"type": "integer"
},
"tt": {
"$ref": "#/$defs/constants/matte-mode",
"title": "Matte Mode"
}
},
"required": [
"ks"
],
"type": "object"
}
],
"description": "Layer used to affect visual elements",
"title": "Visual Layer",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | ed466aa48362f38a3772d3a76fb74de61d31f6be | 2022-08-18T06:28:23 | docs/schema/layers/layer.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/helpers/visual-object"
},
{
"properties": {
"ddd": {
"$ref": "#/$defs/helpers/int-boolean",
"default": 0,
"description": "Whether the layer is threedimensional",
"title": "Threedimensional"
},
"hd": {
"description": "Whether the layer is hidden",
"title": "Hidden",
"type": "boolean"
},
"ind": {
"description": "Index that can be used for parenting and referenced in expressions",
"title": "Index",
"type": "integer"
},
"ip": {
"description": "Frame when the layer becomes visible",
"title": "In Point",
"type": "number"
},
"op": {
"description": "Frame when the layer becomes invisible",
"title": "Out Point",
"type": "number"
},
"parent": {
"description": "Must be the `ind` property of another layer",
"title": "Parent Index",
"type": "integer"
},
"sr": {
"caniuse": "property-time-stretch",
"default": 1,
"title": "Time Stretch",
"type": "number"
},
"st": {
"default": 0,
"title": "Start Time",
"type": "number"
},
"ty": {
"description": "Layer Type",
"oneOf": [
{
"const": 0,
"title": "Precomposition layer"
},
{
"const": 1,
"title": "Solid color layer"
},
{
"const": 2,
"title": "Image layer"
},
{
"const": 3,
"title": "Null layer"
},
{
"const": 4,
"title": "Shape layer"
},
{
"const": 5,
"title": "Text layer"
},
{
"const": 6,
"title": "Audio layer"
},
{
"const": 7,
"title": "Video placeholder"
},
{
"const": 8,
"title": "Image sequence"
},
{
"const": 9,
"title": "Video layer"
},
{
"const": 10,
"title": "Image placeholder"
},
{
"const": 11,
"title": "Guide layer"
},
{
"const": 12,
"title": "Adjustment layer"
},
{
"const": 13,
"title": "Camera"
},
{
"const": 14,
"title": "Light layer"
},
{
"const": 15,
"title": "Data layer"
}
],
"title": "Type",
"type": "integer"
}
},
"required": [
"ty",
"st",
"ip",
"op"
],
"type": "object"
}
],
"description": "",
"title": "Layer",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 837607e8c9b559b972ec0a23ff635fd5a5c59aa9 | 2021-10-18T11:25:08 | docs/schema/shapes/ellipse.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/shapes/shape"
},
{
"properties": {
"p": {
"$ref": "#/properties/multi-dimensional",
"title": "Position"
},
"s": {
"$ref": "#/properties/multi-dimensional",
"title": "Size"
},
"ty": {
"const": "el",
"title": "Type",
"type": "string"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "Ellipse shape",
"title": "Ellipse",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | e9d4d6e4eff25566ce57efa4f37d3fb3aa81571b | 2021-11-24T08:35:54 | docs/schema/helpers/marker.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Defines named portions of the composition.",
"properties": {
"cm": {
"title": "Comment",
"type": "string"
},
"dr": {
"title": "Duration",
"type": "number"
},
"tm": {
"title": "Time",
"type": "number"
}
},
"title": "Marker",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 60369b88e3c4533a96311eb3a2261405623d9653 | 2022-04-10T05:27:44 | docs/schema/constants/stroke-dash-type.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Type of a dash item in a stroked line",
"oneOf": [
{
"const": "d",
"title": "Dash"
},
{
"const": "g",
"title": "Gap"
},
{
"const": "o",
"title": "Offset"
}
],
"title": "StrokeDashType",
"type": "string"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 9b039d896c6016aaa1932ecd8f260e55f6b0b7ca | 2021-10-19T06:04:07 | docs/schema/shapes/base-stroke.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"properties": {
"d": {
"items": {
"$ref": "#/$defs/shapes/stroke-dash"
},
"title": "Dashes",
"type": "array"
},
"lc": {
"$ref": "#/$defs/constants/line-cap",
"default": 2,
"title": "Line Cap"
},
"lj": {
"$ref": "#/$defs/constants/line-join",
"default": 2,
"title": "Line Join"
},
"ml": {
"default": 0,
"title": "Miter Limit",
"type": "number"
},
"o": {
"$ref": "#/$defs/animated-properties/value",
"title": "Opacity"
},
"w": {
"$ref": "#/$defs/animated-properties/value",
"title": "Width"
}
},
"required": [],
"type": "object"
}
],
"description": "",
"title": "Base Stroke",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | da3ae61476e4152b99863da32d0024d9fbf8182c | 2022-04-10T10:34:14 | docs/schema/constants/mask-mode.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "How masks interact with each other. See https://helpx.adobe.com/after-effects/using/alpha-channels-masks-mattes.html",
"oneOf": [
{
"const": "n",
"title": "No"
},
{
"const": "a",
"title": "Add"
},
{
"const": "s",
"title": "Subtract"
},
{
"const": "i",
"title": "Intersect"
},
{
"const": "l",
"title": "Lighten"
},
{
"const": "d",
"title": "Darken"
},
{
"const": "f",
"title": "Difference"
}
],
"title": "MaskMode",
"type": "string"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 26e06cd7aa758ae68e95cc4b0b97c64571411b86 | 2022-11-01T09:29:58 | docs/schema/text/text-follow-path.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"properties": {
"a": {
"$ref": "#/$defs/animated-properties/value",
"title": "Force Alignment"
},
"f": {
"$ref": "#/$defs/animated-properties/value",
"title": "First Margin"
},
"l": {
"$ref": "#/$defs/animated-properties/value",
"title": "Last Margin"
},
"m": {
"description": "Index of the mask to use",
"title": "Mask",
"type": "integer"
},
"p": {
"$ref": "#/$defs/animated-properties/value",
"title": "Perpendicular To Path"
},
"r": {
"$ref": "#/$defs/animated-properties/value",
"title": "Reverse Path"
}
},
"required": [],
"type": "object"
}
],
"caniuse": "text-path",
"description": "Uses the path described by a layer mask to put the text on said path.",
"title": "Text Follow Path",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | aeb6203943d96bbb6d881e7ba8bbc8aeed3b508a | 2022-06-29T07:15:44 | docs/schema/expressions.schema.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$defs": {
"function": {
"oneOf": [
{
"$ref": "#/$defs/function_definition"
},
{
"items": {
"$ref": "#/$defs/function_definition"
},
"type": "array"
},
{
"properties": {
"alias_of": {
"type": "string"
}
},
"type": "object"
}
]
},
"function_definition": {
"properties": {
"description": {
"type": "string"
},
"params": {
"items": {
"$ref": "#/$defs/parameter"
},
"type": "array"
},
"return": {
"$ref": "#/$defs/variable"
}
},
"type": "object"
},
"parameter": {
"allOf": [
{
"$ref": "#/$defs/variable"
},
{
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
]
},
"type": {
"bnf": {
"ARRAY": "array | array [ NUMBER ]",
"DESCRIPTION": "/.+ .+/",
"NUMBER": "/[0-9]+/",
"OPTIONS": "SPECIFIC | OPTIONS | SPECIFIC",
"SPECIFIC": "any | number | boolean | string | object | ARRAY",
"TYPE": "DESCRIPTION | SPECIFIC | OPTIONS"
},
"type": "string"
},
"variable": {
"properties": {
"default": {},
"description": {
"type": "string"
},
"notes": {
"type": "string"
},
"type": {
"$ref": "#/$defs/type"
}
},
"required": [
"description",
"type"
],
"type": "object"
}
},
"$id": "https://lottiefiles.github.io/lottie-docs/schema/expressions.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"aliases": {
"description": "Map alias name to actual function",
"type": "object"
},
"functions": {
"patternProperties": {
".+": {
"$ref": "#/$defs/function"
}
},
"type": "object"
},
"variables": {
"patternProperties": {
".+": {
"$ref": "#/$defs/variable"
}
},
"type": "object"
}
},
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 60369b88e3c4533a96311eb3a2261405623d9653 | 2022-04-10T05:27:44 | docs/schema/constants/text-justify.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Text alignment / justification",
"oneOf": [
{
"const": 0,
"title": "Left"
},
{
"const": 1,
"title": "Right"
},
{
"const": 2,
"title": "Center"
},
{
"const": 3,
"title": "Justify with Last Line Left"
},
{
"const": 4,
"title": "Justify with Last Line Right"
},
{
"const": 5,
"title": "Justify with Last Line Center"
},
{
"const": 6,
"title": "Justify with Last Line Full"
}
],
"title": "TextJustify",
"type": "integer"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 8aa6f4352d17c171d760ec5ae45cb4d454f3a5c6 | 2024-04-10T07:59:29 | docs/schema/animation/animation.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/helpers/visual-object"
},
{
"properties": {
"assets": {
"description": "List of assets that can be referenced by layers",
"items": {
"oneOf": [
{
"$ref": "#/$defs/assets/image"
},
{
"$ref": "#/$defs/assets/precomposition"
},
{
"$ref": "#/$defs/assets/sound"
},
{
"$ref": "#/$defs/assets/data-source"
}
]
},
"title": "Assets",
"type": "array"
},
"chars": {
"description": "Data defining text characters as lottie shapes. If present a player might only render characters defined here and nothing else.",
"items": {
"$ref": "#/$defs/text/character-data"
},
"title": "Characters",
"type": "array"
},
"comps": {
"description": "List of Extra compositions not referenced by anything",
"items": {
"$ref": "#/$defs/assets/precomposition"
},
"title": "Extra Compositions",
"type": "array"
},
"ddd": {
"$ref": "#/$defs/helpers/int-boolean",
"default": 0,
"description": "Whether the animation has 3D layers",
"title": "Threedimensional"
},
"fonts": {
"$ref": "#/$defs/text/font-list",
"title": "Fonts"
},
"fr": {
"default": 60,
"description": "Framerate in frames per second",
"title": "Framerate",
"type": "number"
},
"h": {
"default": 512,
"description": "Height of the animation",
"title": "Height",
"type": "integer"
},
"ip": {
"default": 0,
"description": "\"In Point\", which frame the animation starts at (usually 0)",
"title": "In Point",
"type": "number"
},
"markers": {
"description": "Markers defining named sections of the composition.",
"items": {
"$ref": "#/$defs/helpers/marker"
},
"title": "Markers",
"type": "array"
},
"mb": {
"$ref": "#/$defs/animation/motion-blur",
"title": "Motion Blur"
},
"meta": {
"$ref": "#/$defs/animation/metadata",
"description": "Document metadata",
"title": "Metadata"
},
"metadata": {
"$ref": "#/$defs/animation/user-metadata",
"title": "User Metadata"
},
"op": {
"default": 60,
"description": "\"Out Point\", which frame the animation stops/loops at, which makes this the duration in frames when `ip` is 0",
"title": "Out Point",
"type": "number"
},
"slots": {
"description": "Available property overrides",
"patternProperties": {
".*": {
"p": {
"anyOf": [
{
"$ref": "#/$defs/animated-properties/multi-dimensional"
},
{
"$ref": "#/$defs/animated-properties/color-value"
},
{
"$ref": "#/$defs/animated-properties/position"
},
{
"$ref": "#/$defs/animated-properties/shape-property"
},
{
"$ref": "#/$defs/animated-properties/value"
},
{
"$ref": "#/$defs/assets/image"
},
{
"$ref": "#/$defs/text/animated-text-document"
}
]
},
"required": [
"p"
]
}
},
"title": "Slots",
"type": "object"
},
"v": {
"default": "5.5.2",
"title": "Version",
"type": "string"
},
"w": {
"default": 512,
"description": "Width of the animation",
"title": "Width",
"type": "integer"
}
},
"required": [
"w",
"h",
"fr",
"layers",
"op",
"ip"
],
"type": "object"
},
{
"$ref": "#/$defs/animation/composition"
}
],
"description": "Top level object, describing the animation",
"title": "Animation",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | ad6466364fd22077a6a974c1af408e1be686a10f | 2022-09-16T07:13:26 | docs/schema/constants/blend-mode.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Layer and shape blend mode",
"oneOf": [
{
"const": 0,
"title": "Normal"
},
{
"const": 1,
"title": "Multiply"
},
{
"const": 2,
"title": "Screen"
},
{
"const": 3,
"title": "Overlay"
},
{
"const": 4,
"title": "Darken"
},
{
"const": 5,
"title": "Lighten"
},
{
"const": 6,
"title": "Color Dodge"
},
{
"const": 7,
"title": "Color Burn"
},
{
"const": 8,
"title": "Hard Light"
},
{
"const": 9,
"title": "Soft Light"
},
{
"const": 10,
"title": "Difference"
},
{
"const": 11,
"title": "Exclusion"
},
{
"const": 12,
"title": "Hue"
},
{
"const": 13,
"title": "Saturation"
},
{
"const": 14,
"title": "Color"
},
{
"const": 15,
"title": "Luminosity"
},
{
"const": 16,
"title": "Add"
},
{
"const": 17,
"title": "Hard Mix"
}
],
"title": "BlendMode",
"type": "integer"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 276ea144fe1fffe4ff81b9088dd0422b0bc42ba2 | 2022-04-09T19:57:22 | docs/schema/helpers/mask.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/helpers/visual-object"
},
{
"properties": {
"inv": {
"default": false,
"title": "Inverted",
"type": "boolean"
},
"mode": {
"$ref": "#/$defs/constants/mask-mode",
"default": "i",
"title": "Mode"
},
"o": {
"$ref": "#/$defs/animated-properties/value",
"title": "Opacity"
},
"pt": {
"$ref": "#/$defs/animated-properties/shape-property",
"title": "Shape"
},
"x": {
"$ref": "#/$defs/animated-properties/value",
"title": "Dilate"
}
},
"required": [],
"type": "object"
}
],
"description": "Bezier shape used to mask/clip a layer",
"title": "Mask",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 5a455049fcd3a4734aeea9d182232e47b17b2916 | 2021-10-25T18:55:59 | docs/schema/shapes/gradient.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"properties": {
"a": {
"$ref": "#/$defs/animated-properties/value",
"title": "Highlight Angle"
},
"e": {
"$ref": "#/$defs/animated-properties/multi-dimensional",
"title": "End Point"
},
"g": {
"$ref": "#/$defs/animated-properties/gradient-colors",
"title": "Colors"
},
"h": {
"$ref": "#/$defs/animated-properties/value",
"title": "Highlight Length"
},
"s": {
"$ref": "#/$defs/animated-properties/multi-dimensional",
"title": "Start Point"
},
"t": {
"$ref": "#/$defs/constants/gradient-type",
"default": 1,
"title": "Gradient Type"
}
},
"required": [
"s",
"e",
"g"
],
"type": "object"
}
],
"description": "",
"title": "Gradient",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 7ab43250f875ab2a1ef764f843e2133a04c83233 | 2022-06-14T18:39:05 | docs/schema/text/character-shapes.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Defines a character as shapes",
"properties": {
"shapes": {
"$ref": "#/$defs/shapes/shape-list",
"description": "Shapes forming the character",
"title": "Shapes"
}
},
"required": [
"shapes"
],
"title": "Character Shape",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 7ab43250f875ab2a1ef764f843e2133a04c83233 | 2022-06-14T18:39:05 | docs/schema/layers/precomposition-layer.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/layers/visual-layer"
},
{
"properties": {
"h": {
"description": "Height of the clipping rect",
"title": "Height",
"type": "integer"
},
"refId": {
"description": "ID of the precomp as specified in the assets",
"title": "Reference Id",
"type": "string"
},
"tm": {
"$ref": "#/$defs/animated-properties/value",
"title": "Time Remapping"
},
"ty": {
"const": 0,
"description": "Layer type",
"title": "Type",
"type": "integer"
},
"w": {
"description": "Width of the clipping rect",
"title": "Width",
"type": "integer"
}
},
"required": [
"ty",
"refId",
"w",
"h"
],
"type": "object"
}
],
"description": "Layer that renders a Precomposition asset",
"title": "Precomposition Layer",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | d4d7b11657e01d91f05f85207c991f040565d18b | 2022-05-20T09:36:32 | docs/schema/layers/layer.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/helpers/visual-object"
},
{
"properties": {
"bm": {
"$ref": "#/$defs/constants/blend-mode",
"default": 0,
"title": "Blend Mode"
},
"cl": {
"description": "CSS class used by the SVG renderer",
"title": "CSS Class",
"type": "string"
},
"ddd": {
"$ref": "#/$defs/helpers/int-boolean",
"default": 0,
"description": "Whether the layer is threedimensional",
"title": "Threedimensional"
},
"hd": {
"description": "Whether the layer is hidden",
"title": "Hidden",
"type": "boolean"
},
"ind": {
"description": "Index that can be used for parenting and referenced in expressions",
"title": "Index",
"type": "integer"
},
"ip": {
"description": "Frame when the layers becomes visible",
"title": "In Point",
"type": "number"
},
"ln": {
"description": "`id` attribute used by the SVG renderer",
"title": "Layer XML ID",
"type": "string"
},
"op": {
"description": "Frame when the layers becomes invisible",
"title": "Out Point",
"type": "number"
},
"parent": {
"description": "Must be the `ind` property of another layer",
"title": "Parent Index",
"type": "integer"
},
"sr": {
"default": 1,
"title": "Time Stretch",
"type": "number"
},
"st": {
"default": 0,
"title": "Start Time",
"type": "number"
},
"tg": {
"description": "tag name used by the SVG renderer",
"title": "Layer XML tag name",
"type": "string"
},
"ty": {
"description": "Layer Type",
"oneOf": [
{
"const": 0,
"title": "Precomposition layer"
},
{
"const": 1,
"title": "Solid color layer"
},
{
"const": 2,
"title": "Image layer"
},
{
"const": 3,
"title": "Null layer"
},
{
"const": 4,
"title": "Shape layer"
},
{
"const": 5,
"title": "Text layer"
},
{
"const": 6,
"title": "Audio layer"
},
{
"const": 7,
"title": "Video placeholder"
},
{
"const": 8,
"title": "Image sequence"
},
{
"const": 9,
"title": "Video layer"
},
{
"const": 10,
"title": "Image placeholder"
},
{
"const": 11,
"title": "Guide layer"
},
{
"const": 12,
"title": "Adjustment layer"
},
{
"const": 13,
"title": "Camera"
},
{
"const": 14,
"title": "Light layer"
},
{
"const": 15,
"title": "Data layer"
}
],
"title": "Type",
"type": "integer"
}
},
"required": [
"ty",
"st",
"ip",
"op"
],
"type": "object"
}
],
"description": "",
"title": "Layer",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 67513d4c25313e68bd4844793786e196ad235825 | 2021-10-24T15:38:44 | docs/schema/animation/motion-blur.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$comment": "Can be exported from AE but is not supported by lottie",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Motion blur settings",
"properties": {
"asl": {
"title": "Adaptive Sample Limit",
"type": "number"
},
"sa": {
"description": "Angle in degrees",
"title": "Shutter Angle",
"type": "number"
},
"sp": {
"description": "Angle in degrees",
"title": "Shutter Phase",
"type": "number"
},
"spf": {
"title": "Samples per Frame",
"type": "number"
}
},
"title": "Motion Blur",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 837607e8c9b559b972ec0a23ff635fd5a5c59aa9 | 2021-10-18T11:25:08 | docs/schema/constants/matte-mode.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "",
"oneOf": [
{
"const": 0,
"title": "Normal"
},
{
"const": 1,
"title": "Alpha"
},
{
"const": 2,
"title": "Inverted Alpha"
},
{
"const": 3,
"title": "Luma"
},
{
"const": 4,
"title": "Inverted Luma"
}
],
"title": "MatteMode",
"type": "integer"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 58ded472e45867cf164ea2fcc91bad061cb88224 | 2022-06-20T14:24:59 | docs/schema/shapes/merge.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/shapes/shape-element"
},
{
"properties": {
"mm": {
"default": 1,
"title": "Merge Mode",
"type": "number"
},
"ty": {
"const": "mm",
"title": "Shape Type",
"type": "string"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"caniuse": "shape-merge-path",
"description": "Boolean operator on shapes",
"title": "Merge",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 5a455049fcd3a4734aeea9d182232e47b17b2916 | 2021-10-25T18:55:59 | docs/schema/shapes/rounded-corners.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/shapes/modifier"
},
{
"properties": {
"r": {
"$ref": "#/$defs/animated-properties/value",
"title": "Radius"
},
"ty": {
"const": "rd",
"title": "Shape Type",
"type": "string"
}
},
"required": [
"ty",
"r"
],
"type": "object"
}
],
"description": "Rounds corners of other shapes",
"title": "Rounded Corners",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | a330dc23e69c9a43e108db57890902a6383d9da2 | 2021-10-27T07:34:28 | docs/schema/effect-values/drop-down.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/effect-values/effect-value"
},
{
"properties": {
"ty": {
"const": 7,
"title": "Type",
"type": "integer"
},
"v": {
"$ref": "#/$defs/animated-properties/value",
"title": "Value"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "",
"title": "Effect Value Drop Down",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 38f08072f59623a1357a829d27be6725a0c3b871 | 2022-06-16T11:06:37 | docs/schema/text/character-data.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Defines character shapes",
"properties": {
"ch": {
"default": "",
"title": "Character",
"type": "string"
},
"data": {
"oneOf": [
{
"$ref": "#/$defs/text/character-shapes"
},
{
"$ref": "#/$defs/text/character-precomp"
}
],
"title": "Data"
},
"fFamily": {
"default": "",
"title": "Font Family",
"type": "string"
},
"size": {
"default": 0,
"title": "Font Size",
"type": "number"
},
"style": {
"default": "",
"title": "Font Style",
"type": "string"
},
"w": {
"default": 0,
"title": "Width",
"type": "number"
}
},
"required": [
"data",
"ch",
"fFamily",
"size",
"style",
"w"
],
"title": "Chars",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 2ba3932aaf9c1a49ae2e2289a1e7094977bb41ff | 2023-04-11T13:04:53 | docs/schema/constants/mask-mode.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "How masks interact with each other. See https://helpx.adobe.com/after-effects/using/alpha-channels-masks-mattes.html",
"oneOf": [
{
"const": "n",
"title": "None"
},
{
"const": "a",
"title": "Add"
},
{
"const": "s",
"title": "Subtract"
},
{
"const": "i",
"title": "Intersect"
},
{
"const": "l",
"title": "Lighten"
},
{
"const": "d",
"title": "Darken"
},
{
"const": "f",
"title": "Difference"
}
],
"title": "Mask Mode",
"type": "string"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 6b3835d19cde824a351fcb7073dd9706d2133ebd | 2022-04-11T17:45:33 | docs/schema/animated-properties/keyframe-base.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"properties": {
"h": {
"$ref": "#/$defs/helpers/int-boolean",
"default": 0,
"title": "Hold"
},
"t": {
"default": 0,
"title": "Time",
"type": "number"
}
}
},
{
"if": {
"oneOf": [
{
"properties": {
"h": {
"const": 0
}
}
},
{
"not": {
"required": [
"h"
]
}
}
]
},
"then": {
"properties": {
"i": {
"$ref": "#/$defs/animated-properties/keyframe-bezier-handle",
"description": "Easing tangent going into the next keyframe",
"title": "In Tangent"
},
"o": {
"$ref": "#/$defs/animated-properties/keyframe-bezier-handle",
"description": "Easing tangent leaving the current keyframe",
"title": "Out Tangent"
}
}
}
}
],
"description": "A Keyframes specifies the value at a specific time and the interpolation function to reach the next keyframe.",
"required": [
"t",
"s"
],
"title": "Keyframe",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 1f6624d3c8f820564062391b309857d6472da2b1 | 2021-10-19T10:41:56 | docs/schema/helpers/visual-object.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"properties": {
"mn": {
"description": "Match name, used in expression",
"title": "Match Name",
"type": "string"
},
"nm": {
"description": "Name, as seen from editors and the like",
"title": "Name",
"type": "string"
}
},
"required": [],
"type": "object"
}
],
"description": "",
"title": "Visual Object",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 9b039d896c6016aaa1932ecd8f260e55f6b0b7ca | 2021-10-19T06:04:07 | docs/schema/layers/null-layer.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/layers/layer"
},
{
"properties": {
"ty": {
"const": 3,
"title": "Type",
"type": "integer"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "Layer with no data, useful to group layers together",
"title": "Null Layer",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 296b695db8e508ea2312fbc780ec7668d9ee748c | 2022-04-09T13:17:32 | docs/schema/text/font.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"properties": {
"ascent": {
"title": "Ascent",
"type": "number"
},
"fClass": {
"description": "CSS Class applied to text objects using this font",
"title": "CSS Class",
"type": "string"
},
"fFamily": {
"default": "sans",
"title": "Font Family",
"type": "string"
},
"fName": {
"default": "sans-Regular",
"description": "Name used by text documents to reference this font, usually it's `fFamily` followed by `fStyle`",
"title": "Name",
"type": "string"
},
"fPath": {
"title": "Path",
"type": "string"
},
"fStyle": {
"default": "Regular",
"examples": [
"Regular",
"Bold",
"Bold Italic"
],
"title": "Font Style",
"type": "string"
},
"fWeight": {
"title": "Weight",
"type": "string"
},
"origin": {
"$ref": "#/$defs/constants/font-path-origin",
"title": "Origin"
}
},
"required": [
"fFamily",
"fName",
"fStyle"
],
"type": "object"
}
],
"description": "",
"title": "Font",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | d301bfaaea449b0328d9a4ab58b3a1705b1787dc | 2021-10-23T12:05:07 | docs/schema/assets/asset.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"properties": {
"id": {
"default": "",
"description": "Identifier used by layers when referencing this asset",
"title": "ID",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}
],
"description": "",
"title": "Asset",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | bc9a3f40c7bbf65091fcc23505f5e641bd1e6527 | 2022-07-09T16:10:00 | docs/schema/shapes/fill.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/shapes/shape-element"
},
{
"properties": {
"c": {
"$ref": "#/$defs/animated-properties/color-value",
"title": "Color"
},
"o": {
"$ref": "#/$defs/animated-properties/value",
"description": "Opacity, 100 means fully opaque",
"title": "Opacity"
},
"r": {
"$ref": "#/$defs/constants/fill-rule",
"title": "Fill Rule"
},
"ty": {
"const": "fl",
"title": "Shape Type",
"type": "string"
}
},
"required": [
"ty",
"c",
"o"
],
"type": "object"
}
],
"caniuse": "shape-fill",
"description": "Solid fill color",
"title": "Fill",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | c20e1c24201d8c22737ab6bb9670dfc26ba81c8d | 2022-07-30T07:33:13 | docs/schema/animation/user-metadata.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "User-defined metadata",
"properties": {
"customProps": {
"title": "Custom Properties",
"type": "object"
},
"filename": {
"title": "Filename",
"type": "string"
}
},
"title": "User Metadata",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | f2c98efb1a995f20fe93d58d8f02d31300595c84 | 2021-12-08T05:43:01 | docs/schema/animation/animation.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/helpers/visual-object"
},
{
"$ref": "#/$defs/helpers/three-dimensional"
},
{
"properties": {
"assets": {
"items": {
"oneOf": [
{
"$ref": "#/$defs/assets/image"
},
{
"$ref": "#/$defs/assets/precomposition"
},
{
"$ref": "#/$defs/assets/sound"
}
]
},
"title": "Assets",
"type": "array"
},
"chars": {
"description": "Data defining text characters as lottie shapes",
"items": {
"$ref": "#/$defs/text/character-data"
},
"title": "Chars",
"type": "array"
},
"fonts": {
"$ref": "#/$defs/text/font-list",
"title": "Fonts"
},
"fr": {
"default": 60,
"description": "Framerate in frames per second",
"title": "Framerate",
"type": "number"
},
"h": {
"default": 512,
"description": "Height of the animation",
"title": "Height",
"type": "integer"
},
"ip": {
"default": 0,
"description": "\"In Point\", which frame the animation starts at (usually 0)",
"title": "In Point",
"type": "number"
},
"markers": {
"description": "Markers defining named sections of the composition.",
"items": {
"$ref": "#/$defs/helpers/marker"
},
"title": "Markers",
"type": "array"
},
"mb": {
"$ref": "#/$defs/animation/motion-blur",
"title": "Motion Blur"
},
"meta": {
"$ref": "#/$defs/animation/metadata",
"description": "Document metadata",
"title": "Metadata"
},
"op": {
"default": 60,
"description": "\"Out Point\", which frame the animation stops/loops at, which makes this the duration in frames when `ip` is 0",
"title": "Out Point",
"type": "number"
},
"v": {
"default": "5.5.2",
"title": "Version",
"type": "string"
},
"w": {
"default": 512,
"description": "Width of the animation",
"title": "Width",
"type": "integer"
}
},
"required": [
"w",
"h",
"fr",
"layers",
"op",
"ip"
],
"type": "object"
},
{
"$ref": "#/$defs/animation/composition"
}
],
"description": "Top level object, describing the animation",
"title": "Animation",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | a4da5f152abef365558dc96cb7ac27e75f4effa3 | 2022-11-01T12:20:00 | docs/schema/constants/text-shape.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Defines the function used to determine the interpolating factor on a text range selector.",
"oneOf": [
{
"const": 1,
"title": "Square"
},
{
"const": 2,
"title": "Ramp Up"
},
{
"const": 3,
"title": "Ramp Down"
},
{
"const": 4,
"title": "Triangle"
},
{
"const": 5,
"title": "Round"
},
{
"const": 6,
"title": "Smooth"
}
],
"title": "Text Shape",
"type": "integer"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 56d7a10d0714f51c659b4489d46a14da6271c6d7 | 2022-10-11T11:51:18 | docs/schema/animated-properties/keyframe-base.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"properties": {
"h": {
"$ref": "#/$defs/helpers/int-boolean",
"default": 0,
"title": "Hold"
},
"t": {
"default": 0,
"title": "Time",
"type": "number"
}
}
},
{
"if": {
"oneOf": [
{
"properties": {
"h": {
"const": 0
}
}
},
{
"not": {
"required": [
"h"
]
}
}
]
},
"then": {
"properties": {
"i": {
"$ref": "#/$defs/animated-properties/keyframe-bezier-handle",
"description": "Easing tangent going into the next keyframe",
"title": "In Tangent"
},
"o": {
"$ref": "#/$defs/animated-properties/keyframe-bezier-handle",
"description": "Easing tangent leaving the current keyframe",
"title": "Out Tangent"
}
}
}
}
],
"description": "A Keyframes specifies the value at a specific time and the interpolation function to reach the next keyframe.",
"required": [
"t",
"s"
],
"title": "Base Keyframe",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 2abaff9e2603ed71e6f94cc1e65d2d02f582df60 | 2022-04-09T15:02:43 | docs/schema/helpers/bezier.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Single bezier curve",
"properties": {
"c": {
"default": false,
"title": "Closed",
"type": "boolean"
},
"i": {
"description": "Array of points, each point is an array of coordinates.\nThese points are along the `in` tangents relative to the corresponding `v`.",
"items": {
"items": {
"default": [],
"type": "number"
},
"type": "array"
},
"title": "In Tangents",
"type": "array"
},
"o": {
"description": "Array of points, each point is an array of coordinates.\nThese points are along the `out` tangents relative to the corresponding `v`.",
"items": {
"items": {
"default": [],
"type": "number"
},
"type": "array"
},
"title": "Out Tangents",
"type": "array"
},
"v": {
"description": "Array of points, each point is an array of coordinates.\nThese points are along the bezier path",
"items": {
"items": {
"default": [],
"type": "number"
},
"type": "array"
},
"title": "Vertices",
"type": "array"
}
},
"required": [
"i",
"v",
"o"
],
"title": "Bezier",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | d301bfaaea449b0328d9a4ab58b3a1705b1787dc | 2021-10-23T12:05:07 | docs/schema/shapes/shape-element.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/helpers/visual-object"
},
{
"properties": {
"bm": {
"$ref": "#/$defs/constants/blend-mode",
"title": "Blend Mode"
},
"hd": {
"description": "Whether the shape is hidden",
"title": "Hidden",
"type": "boolean"
},
"ty": {
"oneOf": [
{
"const": "rc",
"title": "Rectangle"
},
{
"const": "el",
"title": "Ellipse"
},
{
"const": "sr",
"title": "Polygon / Star"
},
{
"const": "sh",
"title": "Path"
},
{
"const": "fl",
"title": "Fill"
},
{
"const": "st",
"title": "Stroke"
},
{
"const": "gf",
"title": "Gradient fill"
},
{
"const": "gs",
"title": "Gradient stroke"
},
{
"const": "gr",
"title": "Group"
},
{
"const": "tr",
"title": "Transform"
},
{
"const": "rd",
"title": "Rounded corners"
},
{
"const": "pb",
"title": "Pucker / bloat"
},
{
"const": "mm",
"title": "Merge"
},
{
"const": "tw",
"title": "Twist"
},
{
"const": "op",
"title": "Offset path"
}
],
"title": "Shape Type",
"type": "string"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "Base class for all elements of ShapeLayer and Group",
"title": "Shape Element",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 2e01bcce70e151403206546586b3d755601193ed | 2022-05-06T13:24:23 | docs/schema/layers/solid-color-layer.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/layers/visual-layer"
},
{
"properties": {
"sc": {
"default": "",
"description": "Color of the layer, unlike most other places, the color is a `#rrggbb` hex string",
"title": "Color",
"type": "string"
},
"sh": {
"title": "Height",
"type": "number"
},
"sw": {
"title": "Width",
"type": "number"
},
"ty": {
"const": 1,
"description": "Layer type",
"title": "Type",
"type": "integer"
}
},
"required": [
"ty",
"sc",
"sw",
"sh"
],
"type": "object"
}
],
"description": "Layer with a solid color rectangle",
"title": "Solid Color Layer",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 837607e8c9b559b972ec0a23ff635fd5a5c59aa9 | 2021-10-18T11:25:08 | docs/schema/shapes/fill.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/shapes/shape-element"
},
{
"properties": {
"c": {
"$ref": "#/properties/color-value",
"title": "Color"
},
"o": {
"$ref": "#/properties/value",
"title": "Opacity"
},
"r": {
"$ref": "#/constants/fill-rule",
"title": "Fill Rule"
},
"ty": {
"const": "fl",
"title": "Type",
"type": "string"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "Solid fill color",
"title": "Fill",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 837607e8c9b559b972ec0a23ff635fd5a5c59aa9 | 2021-10-18T11:25:08 | docs/schema/assets/image.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/assets/asset"
},
{
"properties": {
"e": {
"$ref": "#/types/int-boolean",
"default": 0,
"title": "Is Embedded"
},
"h": {
"default": 0,
"title": "Height",
"type": "number"
},
"id": {
"default": "",
"title": "Id",
"type": "string"
},
"p": {
"default": "",
"title": "Image",
"type": "string"
},
"u": {
"default": "",
"title": "Image Path",
"type": "string"
},
"w": {
"default": 0,
"title": "Width",
"type": "number"
}
},
"required": [],
"type": "object"
}
],
"description": "External image\n\n@see http://docs.aenhancers.com/sources/filesource/",
"title": "Image",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 718213e5e7f2fb9f87829f70a6593b4d739e43eb | 2021-10-26T07:06:57 | docs/schema/shapes/ellipse.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/shapes/shape"
},
{
"properties": {
"p": {
"$ref": "#/$defs/animated-properties/position",
"title": "Position"
},
"s": {
"$ref": "#/$defs/animated-properties/multi-dimensional",
"title": "Size"
},
"ty": {
"const": "el",
"title": "Shape Type",
"type": "string"
}
},
"required": [
"ty",
"s",
"p"
],
"type": "object"
}
],
"description": "Ellipse shape",
"title": "Ellipse",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 3723525748cf1d1d67fff3603327367a2a22643b | 2021-10-26T11:55:22 | docs/schema/effects/fill-effect.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/effects/effect"
},
{
"properties": {
"ef": {
"prefixItems": [
{
"$ref": "#/$defs/effects/effect-value-point",
"title": "00"
},
{
"$ref": "#/$defs/effects/effect-value-drop-down",
"title": "01"
},
{
"$ref": "#/$defs/effects/effect-value-color",
"title": "color"
},
{
"$ref": "#/$defs/effects/effect-value-drop-down",
"title": "03"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "04"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"title": "05"
},
{
"$ref": "#/$defs/effects/effect-value-slider",
"description": "Opacity in [0, 1]",
"title": "opacity"
}
],
"title": "Effect values",
"type": "array"
},
"ty": {
"const": 21,
"title": "Type",
"type": "integer"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "Replaces the whole layer with the given color\n@note Opacity is in [0, 1]",
"title": "Fill Effect",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 58ded472e45867cf164ea2fcc91bad061cb88224 | 2022-06-20T14:24:59 | docs/schema/layers/solid-color-layer.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/layers/visual-layer"
},
{
"properties": {
"sc": {
"default": "",
"description": "Color of the layer, unlike most other places, the color is a `#rrggbb` hex string",
"title": "Color",
"type": "string"
},
"sh": {
"title": "Height",
"type": "number"
},
"sw": {
"title": "Width",
"type": "number"
},
"ty": {
"const": 1,
"description": "Layer type",
"title": "Type",
"type": "integer"
}
},
"required": [
"ty",
"sc",
"sw",
"sh"
],
"type": "object"
}
],
"caniuse": "layer-solid",
"description": "Layer with a solid color rectangle",
"title": "Solid Color Layer",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 61923cefc3496b5d860912b78137abf030ad7472 | 2022-04-09T11:47:57 | docs/schema/animated-properties/keyframe.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"properties": {
"h": {
"$ref": "#/$defs/helpers/int-boolean",
"default": 0,
"title": "Hold"
},
"s": {
"description": "Value at this keyframe. Note the if the property is a scalar, keyframe values are still represented as arrays",
"items": {
"type": "number"
},
"title": "Value",
"type": "array"
},
"t": {
"default": 0,
"title": "Time",
"type": "number"
}
}
},
{
"if": {
"oneOf": [
{
"properties": {
"h": {
"const": 0
}
}
},
{
"not": {
"required": [
"h"
]
}
}
]
},
"then": {
"properties": {
"i": {
"$ref": "#/$defs/animated-properties/keyframe-bezier-handle",
"description": "Easing tangent going into the next keyframe",
"title": "In Tangent"
},
"o": {
"$ref": "#/$defs/animated-properties/keyframe-bezier-handle",
"description": "Easing tangent leaving the current keyframe",
"title": "Out Tangent"
}
}
}
}
],
"description": "",
"required": [
"t",
"s"
],
"title": "Keyframe",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 7ce92ecbe87c57f0a66ed19fa889b76cbedb9682 | 2022-05-19T14:42:05 | docs/schema/assets/precomposition.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/assets/asset"
},
{
"$ref": "#/$defs/animation/composition"
},
{
"properties": {
"fr": {
"description": "Framerate in frames per second",
"title": "Framerate",
"type": "number"
},
"xt": {
"$ref": "#/$defs/helpers/int-boolean",
"default": 0,
"description": "Extra composition",
"title": "Extra"
}
},
"type": "object"
}
],
"description": "Asset containing an animation that can be referenced by layers.",
"title": "Precomposition",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 837607e8c9b559b972ec0a23ff635fd5a5c59aa9 | 2021-10-18T11:25:08 | docs/schema/helpers/mask.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/helpers/visual-object"
},
{
"properties": {
"inv": {
"default": false,
"title": "Inverted",
"type": "boolean"
},
"mode": {
"$ref": "#/constants/mask-mode",
"default": "i",
"title": "Mode"
},
"o": {
"$ref": "#/properties/value",
"title": "Opacity"
},
"pt": {
"$ref": "#/properties/shape-property",
"title": "Shape"
},
"x": {
"$ref": "#/properties/value",
"title": "Dilate"
}
},
"required": [],
"type": "object"
}
],
"description": "",
"title": "Mask",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | a8c85f92e47f9f41984d770e27e610e5a35bfbd7 | 2022-06-30T15:47:48 | docs/schema/styles/bevel-emboss-style.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/styles/layer-style"
},
{
"properties": {
"a": {
"$ref": "#/$defs/animated-properties/value",
"description": "Local lighting angle",
"title": "Angle"
},
"bs": {
"$ref": "#/$defs/animated-properties/value",
"title": "Bevel Style"
},
"bt": {
"$ref": "#/$defs/animated-properties/value",
"title": "Technique"
},
"ga": {
"$ref": "#/$defs/animated-properties/value",
"description": "Use global light",
"title": "Global Angle"
},
"hc": {
"$ref": "#/$defs/animated-properties/color-value",
"title": "Highlight Color"
},
"hm": {
"$ref": "#/$defs/animated-properties/value",
"title": "Highlight Mode"
},
"ho": {
"$ref": "#/$defs/animated-properties/value",
"title": "Highlight Opacity"
},
"ll": {
"$ref": "#/$defs/animated-properties/value",
"description": "Local lighting altitude",
"title": "Altitude"
},
"s": {
"$ref": "#/$defs/animated-properties/value",
"title": "Size"
},
"sc": {
"$ref": "#/$defs/animated-properties/color-value",
"title": "Shadow Color"
},
"sf": {
"$ref": "#/$defs/animated-properties/value",
"title": "Soften"
},
"sm": {
"$ref": "#/$defs/animated-properties/value",
"title": "Shadow Mode"
},
"so": {
"$ref": "#/$defs/animated-properties/value",
"title": "Shadow Opacity"
},
"sr": {
"$ref": "#/$defs/animated-properties/value",
"title": "Strength"
},
"ty": {
"const": 5,
"description": "Layer Type",
"title": "Type",
"type": "integer"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"caniuse": "style-bevel-and-emboss",
"title": "Bevel Emboss",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | d4d7b11657e01d91f05f85207c991f040565d18b | 2022-05-20T09:36:32 | docs/schema/styles/satin-style.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/styles/layer-style"
},
{
"properties": {
"a": {
"$ref": "#/$defs/animated-properties/value",
"title": "Angle"
},
"bm": {
"$ref": "#/$defs/animated-properties/value",
"title": "Blend Mode"
},
"c": {
"$ref": "#/$defs/animated-properties/color-value",
"title": "Color"
},
"d": {
"$ref": "#/$defs/animated-properties/value",
"title": "Distance"
},
"in": {
"$ref": "#/$defs/animated-properties/value",
"title": "Invert"
},
"o": {
"$ref": "#/$defs/animated-properties/value",
"title": "Opacity"
},
"s": {
"$ref": "#/$defs/animated-properties/value",
"title": "Size"
},
"ty": {
"const": 6,
"description": "Layer Type",
"title": "Type",
"type": "integer"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"title": "Satin",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 26e06cd7aa758ae68e95cc4b0b97c64571411b86 | 2022-11-01T09:29:58 | docs/schema/constants/star-type.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Star or Polygon",
"oneOf": [
{
"const": 1,
"title": "Star"
},
{
"const": 2,
"title": "Polygon"
}
],
"title": "Star Type",
"type": "integer"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 837607e8c9b559b972ec0a23ff635fd5a5c59aa9 | 2021-10-18T11:25:08 | docs/schema/effects/stroke-effect.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/effects/effect"
},
{
"properties": {
"ty": {
"const": 22,
"title": "Type",
"type": "integer"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "",
"title": "Stroke Effect",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | d8299eea2c14543701e121ac3cb29c78df3b0ad4 | 2024-04-10T07:59:29 | docs/schema/assets/image.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/assets/file-asset"
},
{
"properties": {
"h": {
"default": 0,
"description": "Height of the image",
"title": "Height",
"type": "number"
},
"sid": {
"description": "One of the ID in the file's slots",
"title": "Slot ID",
"type": "string"
},
"t": {
"const": "seq",
"description": "Marks as part of an image sequence if present",
"title": "Type",
"type": "string"
},
"w": {
"default": 0,
"description": "Width of the image",
"title": "Width",
"type": "number"
}
},
"required": [
"p"
],
"type": "object"
}
],
"description": "External image",
"title": "Image",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 6180feff61a75c66ce3c4f1b0ec382cc40653076 | 2021-10-20T14:27:05 | docs/schema/layers/image-layer.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/layers/layer"
},
{
"properties": {
"refId": {
"default": "",
"description": "ID of the image as specified in the assets",
"title": "Image Id",
"type": "string"
},
"ty": {
"const": 2,
"description": "Layer type",
"title": "Type",
"type": "integer"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "",
"title": "Image Layer",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | a330dc23e69c9a43e108db57890902a6383d9da2 | 2021-10-27T07:34:28 | docs/schema/effects/drop-shadow-effect.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/effects/effect"
},
{
"properties": {
"ef": {
"prefixItems": [
{
"$ref": "#/$defs/effect-values/color",
"title": "color"
},
{
"$ref": "#/$defs/effect-values/slider",
"description": "Opacity between 0 and 255",
"title": "opacity"
},
{
"$ref": "#/$defs/effect-values/angle",
"title": "angle"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "distance"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "blur"
}
],
"title": "Effect values",
"type": "array"
},
"ty": {
"const": 25,
"title": "Type",
"type": "integer"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "Adds a shadow to the layer",
"title": "Drop Shadow Effect",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 5a455049fcd3a4734aeea9d182232e47b17b2916 | 2021-10-25T18:55:59 | docs/schema/helpers/bezier.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Single bezier curve",
"properties": {
"c": {
"default": false,
"title": "Closed",
"type": "boolean"
},
"i": {
"items": {
"default": [],
"type": "number"
},
"title": "In Tangents",
"type": "array"
},
"o": {
"items": {
"default": [],
"type": "number"
},
"title": "Out Tangents",
"type": "array"
},
"v": {
"items": {
"default": [],
"type": "number"
},
"title": "Vertices",
"type": "array"
}
},
"required": [
"i",
"v",
"o"
],
"title": "Bezier",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 876fa6fc4ed0d9f3c938cabdd4c559dbb6f79943 | 2021-10-29T12:52:59 | docs/schema/effects/mesh-warp-effect.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/effects/effect"
},
{
"properties": {
"ef": {
"prefixItems": [
{
"$ref": "#/$defs/effect-values/slider",
"title": "Rows"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "Columns"
},
{
"$ref": "#/$defs/effect-values/slider",
"title": "Quality"
},
{
"$ref": "#/$defs/effect-values/no-value",
"title": "03"
}
],
"title": "Effect values",
"type": "array"
},
"ty": {
"const": 31,
"title": "Type",
"type": "integer"
}
},
"required": [
"ty",
"ef"
],
"type": "object"
}
],
"description": "",
"title": "Mesh Warp Effect",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 995d93664e6b1f39be710ac2f6d904cdf9a952e1 | 2022-07-26T09:11:16 | docs/schema/shapes/zig-zag.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/shapes/shape-element"
},
{
"properties": {
"pt": {
"$ref": "#/$defs/animated-properties/value",
"description": "Point type (1 = corner, 2 = smooth)",
"title": "Point Type"
},
"r": {
"$ref": "#/$defs/animated-properties/value",
"description": "Number of ridges per segment",
"title": "Frequency"
},
"s": {
"$ref": "#/$defs/animated-properties/value",
"description": "Distance between peaks and troughs",
"title": "Amplitude"
},
"ty": {
"const": "zz",
"title": "Shape Type",
"type": "string"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"description": "Changes the edges of affected shapes into a series of peaks and valleys of uniform size",
"title": "Zig Zags",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 588e437bfa7c02700905b0863ef71694f302cda2 | 2022-04-18T12:30:02 | docs/schema/helpers/transform.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"properties": {
"a": {
"$ref": "#/$defs/animated-properties/position",
"description": "Anchor point: a position (relative to its parent) around which transformations are applied (ie: center for rotation / scale)",
"title": "Anchor Point"
},
"o": {
"$ref": "#/$defs/animated-properties/value",
"title": "Opacity"
},
"s": {
"$ref": "#/$defs/animated-properties/multi-dimensional",
"description": "Scale factor, `[100, 100]` for no scaling",
"title": "Scale"
},
"sa": {
"$ref": "#/$defs/animated-properties/value",
"description": "Direction along which skew is applied, in degrees (`0` skews along the X axis, `90` along the Y axis)",
"title": "Skew Axis"
},
"sk": {
"$ref": "#/$defs/animated-properties/value",
"description": "Skew amount as an angle in degrees",
"title": "Skew"
}
}
},
{
"anyOf": [
{
"oneOf": [
{
"properties": {
"p": {
"$ref": "#/$defs/animated-properties/position",
"description": "Position / Translation",
"title": "Position"
}
}
},
{
"properties": {
"p": {
"$ref": "#/$defs/animated-properties/split-vector",
"description": "Position / Translation with split components",
"title": "Position"
}
}
}
]
},
{
"oneOf": [
{
"properties": {
"r": {
"$ref": "#/$defs/animated-properties/value",
"description": "Rotation in degrees, clockwise",
"title": "Rotation"
}
}
},
{
"properties": {
"or": {
"$ref": "#/$defs/animated-properties/multi-dimensional",
"title": "Orientation"
},
"rx": {
"$ref": "#/$defs/animated-properties/value",
"description": "Split rotation component",
"title": "X Rotation"
},
"ry": {
"$ref": "#/$defs/animated-properties/value",
"description": "Split rotation component",
"title": "Y Rotation"
},
"rz": {
"$ref": "#/$defs/animated-properties/value",
"description": "Split rotation component, equivalent to `r` when not split",
"title": "Z Rotation"
}
}
}
]
}
]
}
],
"description": "Layer transform",
"title": "Transform",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 4feb7a269d2302c9a68fdb256ee8ac32a253d554 | 2021-12-01T11:13:15 | docs/schema/layers/audio-layer.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/layers/layer"
},
{
"properties": {
"au": {
"$ref": "#/$defs/layers/audio-settings",
"title": "Audio Settings"
},
"ty": {
"const": 6,
"description": "Layer type",
"title": "Type",
"type": "integer"
}
},
"required": [
"ty",
"au"
],
"type": "object"
}
],
"description": "A layer playing sounds",
"title": "Audio Layer",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 2442e7f4a2d24ed583e5c55be1feecf6ed94e9a9 | 2022-02-17T13:50:34 | docs/schema/layers/layer.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/helpers/visual-object"
},
{
"properties": {
"bm": {
"$ref": "#/$defs/constants/blend-mode",
"default": 0,
"title": "Blend Mode"
},
"cl": {
"description": "CSS class used by the SVG renderer",
"title": "CSS Class",
"type": "string"
},
"ddd": {
"$ref": "#/$defs/helpers/int-boolean",
"default": 0,
"description": "Whether the layer is threedimensional",
"title": "Threedimensional"
},
"hd": {
"description": "Whether the layer is hidden",
"title": "Hidden",
"type": "boolean"
},
"ind": {
"title": "Index",
"type": "integer"
},
"ip": {
"description": "Frame when the layers becomes visible",
"title": "In Point",
"type": "number"
},
"ln": {
"description": "`id` attribute used by the SVG renderer",
"title": "Layer XML ID",
"type": "string"
},
"op": {
"description": "Frame when the layers becomes invisible",
"title": "Out Point",
"type": "number"
},
"parent": {
"description": "Must be the `ind` property of another layer",
"title": "Parent Index",
"type": "integer"
},
"sr": {
"default": 1,
"title": "Time Stretch",
"type": "number"
},
"st": {
"default": 0,
"title": "Start Time",
"type": "number"
},
"ty": {
"description": "Layer Type",
"oneOf": [
{
"const": 0,
"title": "Precomposition layer"
},
{
"const": 1,
"title": "Solid color layer"
},
{
"const": 2,
"title": "Image layer"
},
{
"const": 3,
"title": "Null layer"
},
{
"const": 4,
"title": "Shape layer"
},
{
"const": 5,
"title": "Text layer"
},
{
"const": 6,
"title": "Audio layer"
},
{
"const": 7,
"title": "Video placeholder"
},
{
"const": 8,
"title": "Image sequence"
},
{
"const": 9,
"title": "Video layer"
},
{
"const": 10,
"title": "Image placeholder"
},
{
"const": 11,
"title": "Guide layer"
},
{
"const": 12,
"title": "Adjustment layer"
},
{
"const": 13,
"title": "Camera"
},
{
"const": 14,
"title": "Light layer"
}
],
"title": "Type",
"type": "integer"
}
},
"required": [
"ty",
"st",
"ip",
"op"
],
"type": "object"
}
],
"description": "",
"title": "Layer",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 14836b59575d38fe92928f008000d27d89e36b67 | 2021-10-24T09:39:09 | docs/schema/layers/shape-layer.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/layers/layer"
},
{
"properties": {
"shapes": {
"$ref": "#/$defs/shapes/shape-list",
"title": "Shapes"
},
"ty": {
"const": 4,
"description": "Layer type",
"title": "Type",
"type": "integer"
}
},
"required": [
"ty",
"shapes"
],
"type": "object"
}
],
"description": "Layer containing Shapes",
"title": "Shape Layer",
"type": "object"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 837607e8c9b559b972ec0a23ff635fd5a5c59aa9 | 2021-10-18T11:25:08 | docs/schema/constants/line-cap.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "",
"oneOf": [
{
"const": 1,
"title": "Butt"
},
{
"const": 2,
"title": "Round"
},
{
"const": 3,
"title": "Square"
}
],
"title": "LineCap",
"type": "integer"
} | CC-BY-4.0 | en |
LottieFiles/lottie-docs | 58ded472e45867cf164ea2fcc91bad061cb88224 | 2022-06-20T14:24:59 | docs/schema/styles/inner-shadow-style.json | 43 | 2024-05-27T04:43:41.687416Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/$defs/styles/layer-style"
},
{
"properties": {
"a": {
"$ref": "#/$defs/animated-properties/value",
"description": "Local light angle",
"title": "Angle"
},
"bm": {
"$ref": "#/$defs/animated-properties/value",
"title": "Blend Mode"
},
"c": {
"$ref": "#/$defs/animated-properties/color-value",
"title": "Color"
},
"ch": {
"$ref": "#/$defs/animated-properties/value",
"title": "Choke Spread"
},
"d": {
"$ref": "#/$defs/animated-properties/value",
"title": "Distance"
},
"no": {
"$ref": "#/$defs/animated-properties/value",
"title": "Noise"
},
"o": {
"$ref": "#/$defs/animated-properties/value",
"title": "Opacity"
},
"s": {
"$ref": "#/$defs/animated-properties/value",
"description": "Blur size",
"title": "Size"
},
"ty": {
"const": 2,
"description": "Layer Type",
"title": "Type",
"type": "integer"
}
},
"required": [
"ty"
],
"type": "object"
}
],
"caniuse": "style-inner-shadow",
"title": "Inner Shadow",
"type": "object"
} | CC-BY-4.0 | en |
walt-id/waltid-identity | 854c55ff4ef5667560f74b7bb03bd0afe237bfba | 2024-04-11T07:12:14 | waltid-cli/src/jvmTest/resources/schema/OpenBadgeV3_schema.json | 98 | 2024-05-27T10:20:59.936639Z | {
"$defs": {
"Achievement": {
"additionalProperties": true,
"description": "A collection of information about the accomplishment recognized by the Assertion. Many assertions may be created corresponding to one Achievement.",
"properties": {
"achievementType": {
"$comment": "Origin: AchievementType (EnumExt); The type of achievement, for example 'Award' or 'Certification'. This is an extensible enumerated vocabulary. Extending the vocabulary makes use of a naming convention.",
"anyOf": [
{
"enum": [
"Achievement",
"ApprenticeshipCertificate",
"Assessment",
"Assignment",
"AssociateDegree",
"Award",
"Badge",
"BachelorDegree",
"Certificate",
"CertificateOfCompletion",
"Certification",
"CommunityService",
"Competency",
"Course",
"CoCurricular",
"Degree",
"Diploma",
"DoctoralDegree",
"Fieldwork",
"GeneralEducationDevelopment",
"JourneymanCertificate",
"LearningProgram",
"License",
"Membership",
"ProfessionalDoctorate",
"QualityAssuranceCredential",
"MasterCertificate",
"MasterDegree",
"MicroCredential",
"ResearchDoctorate",
"SecondarySchoolDiploma"
],
"type": "string"
},
{
"pattern": "(ext:)[a-z|A-Z|0-9|.|-|_]+",
"type": "string"
}
],
"description": "The type of achievement. This is an extensible vocabulary."
},
"alignment": {
"items": {
"$ref": "#/$defs/Alignment"
},
"type": "array"
},
"creator": {
"$ref": "#/$defs/Profile"
},
"creditsAvailable": {
"$comment": "Origin: Float (PrimitiveType)",
"description": "Credit hours associated with this entity, or credit hours possible. For example 3.0.",
"type": "number"
},
"criteria": {
"$ref": "#/$defs/Criteria"
},
"description": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A short description of the achievement.",
"type": "string"
},
"endorsement": {
"items": {
"$ref": "#/$defs/EndorsementCredential"
},
"type": "array"
},
"endorsementJwt": {
"items": {
"$comment": "Origin: CompactJws (DerivedType); A `String` in Compact JWS format [[RFC7515]].",
"description": "Allows endorsers to make specific claims about the Achievement. These endorsements are signed with the VC-JWT proof format.",
"pattern": "^[a-zA-Z0-9_-]+\\.[a-zA-Z0-9_-]*\\.[a-zA-Z0-9_-]+$",
"type": "string"
},
"type": "array"
},
"fieldOfStudy": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Category, subject, area of study, discipline, or general branch of knowledge. Examples include Business, Education, Psychology, and Technology.",
"type": "string"
},
"humanCode": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The code, generally human readable, associated with an achievement.",
"type": "string"
},
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "Unique URI for the Achievement.",
"type": "string"
},
"image": {
"$ref": "#/$defs/Image"
},
"inLanguage": {
"$comment": "Origin: LanguageCode (DerivedType); A language code [[BCP47]].",
"description": "The language of the achievement.",
"pattern": "^[a-z]{2,4}(-[A-Z][a-z]{3})?(-([A-Z]{2}|[0-9]{3}))?$",
"type": "string"
},
"name": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The name of the achievement.",
"type": "string"
},
"otherIdentifier": {
"items": {
"$ref": "#/$defs/IdentifierEntry"
},
"type": "array"
},
"related": {
"items": {
"$ref": "#/$defs/Related"
},
"type": "array"
},
"resultDescription": {
"items": {
"$ref": "#/$defs/ResultDescription"
},
"type": "array"
},
"specialization": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Name given to the focus, concentration, or specific area of study defined in the achievement. Examples include 'Entrepreneurship', 'Technical Communication', and 'Finance'.",
"type": "string"
},
"tag": {
"items": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "One or more short, human-friendly, searchable, keywords that describe the type of achievement.",
"type": "string"
},
"type": "array"
},
"type": {
"oneOf": [
{
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "No description supplied.",
"type": "string"
},
{
"items": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "No description supplied.",
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
},
"version": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The version property allows issuers to set a version string for an Achievement. This is particularly useful when replacing a previous version with an update.",
"type": "string"
}
},
"required": [
"id",
"type",
"criteria",
"description",
"name"
],
"type": "object"
},
"AchievementSubject": {
"additionalProperties": true,
"description": "A collection of information about the recipient of an achievement. Maps to Credential Subject in [[VC-DATA-MODEL]].",
"properties": {
"achievement": {
"$ref": "#/$defs/Achievement"
},
"activityEndDate": {
"$comment": "Origin: DateTime (PrimitiveType); An [[ISO8601]] time using the syntax YYYY-MM-DDThh:mm:ss.",
"description": "The datetime the activity ended.",
"format": "date-time",
"type": "string"
},
"activityStartDate": {
"$comment": "Origin: DateTime (PrimitiveType); An [[ISO8601]] time using the syntax YYYY-MM-DDThh:mm:ss.",
"description": "The datetime the activity started.",
"format": "date-time",
"type": "string"
},
"creditsEarned": {
"$comment": "Origin: Float (PrimitiveType)",
"description": "The number of credits earned, generally in semester or quarter credit hours. This field correlates with the Achievement `creditsAvailable` field.",
"type": "number"
},
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "An identifier for the Credential Subject. Either `id` or at least one `identifier` MUST be supplied.",
"type": "string"
},
"identifier": {
"items": {
"$ref": "#/$defs/IdentityObject"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image"
},
"licenseNumber": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The license number that was issued with this credential.",
"type": "string"
},
"narrative": {
"$comment": "Origin: Markdown (DerivedType); A `String` that may contain Markdown.",
"description": "A narrative that connects multiple pieces of evidence. Likely only present at this location if evidence is a multi-value array.",
"type": "string"
},
"result": {
"items": {
"$ref": "#/$defs/Result"
},
"type": "array"
},
"role": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Role, position, or title of the learner when demonstrating or performing the achievement or evidence of learning being asserted. Examples include 'Student President', 'Intern', 'Captain', etc.",
"type": "string"
},
"source": {
"$ref": "#/$defs/Profile"
},
"term": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The academic term in which this assertion was achieved.",
"type": "string"
},
"type": {
"oneOf": [
{
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'AchievementSubject'.",
"type": "string"
},
{
"items": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'AchievementSubject'.",
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"type",
"achievement"
],
"type": "object"
},
"Address": {
"additionalProperties": true,
"description": "An address for the described entity.",
"properties": {
"addressCountry": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A country.",
"type": "string"
},
"addressCountryCode": {
"$comment": "Origin: CountryCode (DerivedType); A two-digit ISO 3166-1 alpha-2 country code [[ISO3166-1]].",
"description": "A country code. The value must be a ISO 3166-1 alpha-2 country code [[ISO3166-1]].",
"type": "string"
},
"addressLocality": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A locality within the region.",
"type": "string"
},
"addressRegion": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A region within the country.",
"type": "string"
},
"geo": {
"$ref": "#/$defs/GeoCoordinates"
},
"postOfficeBoxNumber": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A post office box number for PO box addresses.",
"type": "string"
},
"postalCode": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A postal code.",
"type": "string"
},
"streetAddress": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A street address within the locality.",
"type": "string"
},
"type": {
"oneOf": [
{
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'Address'.",
"type": "string"
},
{
"items": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'Address'.",
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"type"
],
"type": "object"
},
"Alignment": {
"additionalProperties": true,
"description": "Describes an alignment between an achievement and a node in an educational framework.",
"properties": {
"targetCode": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "If applicable, a locally unique string identifier that identifies the alignment target within its framework and/or targetUrl.",
"type": "string"
},
"targetDescription": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Short description of the alignment target.",
"type": "string"
},
"targetFramework": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Name of the framework the alignment target.",
"type": "string"
},
"targetName": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Name of the alignment.",
"type": "string"
},
"targetType": {
"$comment": "Origin: AlignmentTargetType (EnumExt); The type of the alignment target node in the target framework.",
"anyOf": [
{
"enum": [
"ceasn:Competency",
"ceterms:Credential",
"CFItem",
"CFRubric",
"CFRubricCriterion",
"CFRubricCriterionLevel",
"CTDL"
],
"type": "string"
},
{
"pattern": "(ext:)[a-z|A-Z|0-9|.|-|_]+",
"type": "string"
}
],
"description": "The type of the alignment target node."
},
"targetUrl": {
"$comment": "Origin: URL (DerivedType); A `URI` that represents a Uniform Resource Locator (URL).",
"description": "URL linking to the official description of the alignment target, for example an individual standard within an educational framework.",
"type": "string"
},
"type": {
"oneOf": [
{
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'Alignment'.",
"type": "string"
},
{
"items": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'Alignment'.",
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"type",
"targetName",
"targetUrl"
],
"type": "object"
},
"Context": {
"anyOf": [
{
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"type": "string"
},
{
"$comment": "Origin: Map (Unordered); A map representing an object with unknown, arbitrary properties",
"description": "A map representing an object with unknown, arbitrary properties",
"type": "object"
}
],
"description": "JSON-LD Context. Either a URI with the context definition or a Map with a local context definition MUST be supplied."
},
"CredentialSchema": {
"additionalProperties": true,
"description": "Identify the type and location of a data schema.",
"properties": {
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "The value MUST be a URI identifying the schema file. One instance of `CredentialSchema` MUST have an `id` that is the URL of the JSON Schema for this credential defined by this specification.",
"type": "string"
},
"type": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value MUST identify the type of data schema validation. One instance of `CredentialSchema` MUST have a `type` of 'JsonSchemaValidator2019'.",
"type": "string"
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"CredentialStatus": {
"additionalProperties": true,
"description": "The information in CredentialStatus is used to discover information about the current status of a verifiable credential, such as whether it is suspended or revoked.",
"properties": {
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "The value MUST be the URL of the issuer's credential status method.",
"type": "string"
},
"type": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The name of the credential status method.",
"type": "string"
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"Criteria": {
"additionalProperties": true,
"description": "Descriptive metadata about the achievements necessary to be recognized with an assertion of a particular achievement. This data is added to the Achievement class so that it may be rendered when the achievement assertion is displayed, instead of simply a link to human-readable criteria external to the achievement. Embedding criteria allows either enhancement of an external criteria page or increased portability and ease of use by allowing issuers to skip hosting the formerly-required external criteria page altogether. Criteria is used to allow would-be recipients to learn what is required of them to be recognized with an assertion of a particular achievement. It is also used after the assertion is awarded to a recipient to let those inspecting earned achievements know the general requirements that the recipients met in order to earn it.",
"properties": {
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "The URI of a webpage that describes in a human-readable format the criteria for the achievement.",
"type": "string"
},
"narrative": {
"$comment": "Origin: Markdown (DerivedType); A `String` that may contain Markdown.",
"description": "A narrative of what is needed to earn the achievement. Markdown is allowed.",
"type": "string"
}
},
"required": [],
"type": "object"
},
"EndorsementCredential": {
"additionalProperties": true,
"description": "A verifiable credential that asserts a claim about an entity. As described in [[[#data-integrity]]], at least one proof mechanism, and the details necessary to evaluate that proof, MUST be expressed for a credential to be a verifiable credential. In the case of an embedded proof, the credential MUST append the proof in the `proof` property.",
"properties": {
"@context": {
"items": {
"$ref": "#/$defs/Context"
},
"minItems": 1,
"type": "array"
},
"awardedDate": {
"$comment": "Origin: DateTimeZ (DerivedType); A `DateTime` with the trailing timezone specifier included, e.g. `2021-09-07T02:09:59+02:00`",
"description": "Timestamp of when the credential was awarded. `issuanceDate` is used to determine the most recent version of a Credential in conjunction with `issuer` and `id`. Consequently, the only way to update a Credental is to update the `issuanceDate`, losing the date when the Credential was originally awarded. `awardedDate` is meant to keep this original date.",
"format": "date-time",
"type": "string"
},
"credentialSchema": {
"oneOf": [
{
"$ref": "#/$defs/CredentialSchema"
},
{
"items": {
"$ref": "#/$defs/CredentialSchema"
},
"type": "array"
}
]
},
"credentialStatus": {
"$ref": "#/$defs/CredentialStatus"
},
"credentialSubject": {
"$ref": "#/$defs/EndorsementSubject"
},
"description": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The short description of the credential for display purposes in wallets.",
"type": "string"
},
"expirationDate": {
"$comment": "Origin: DateTimeZ (DerivedType); A `DateTime` with the trailing timezone specifier included, e.g. `2021-09-07T02:09:59+02:00`",
"description": "If the credential has some notion of expiry, this indicates a timestamp when a credential should no longer be considered valid. After this time, the credential should be considered expired.",
"format": "date-time",
"type": "string"
},
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "Unambiguous reference to the credential.",
"type": "string"
},
"issuanceDate": {
"$comment": "Origin: DateTimeZ (DerivedType); A `DateTime` with the trailing timezone specifier included, e.g. `2021-09-07T02:09:59+02:00`",
"description": "Timestamp of when the credential was issued.",
"format": "date-time",
"type": "string"
},
"issuer": {
"$ref": "#/$defs/Profile"
},
"name": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The name of the credential for display purposes in wallets. For example, in a list of credentials and in detail views.",
"type": "string"
},
"proof": {
"oneOf": [
{
"$ref": "#/$defs/Proof"
},
{
"items": {
"$ref": "#/$defs/Proof"
},
"type": "array"
}
]
},
"refreshService": {
"$ref": "#/$defs/RefreshService"
},
"termsOfUse": {
"oneOf": [
{
"$ref": "#/$defs/TermsOfUse"
},
{
"items": {
"$ref": "#/$defs/TermsOfUse"
},
"type": "array"
}
]
},
"type": {
"oneOf": [
{
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the URI 'VerifiableCredential', and one of the items MUST be the URI 'EndorsementCredential'.",
"type": "string"
},
{
"items": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the URI 'VerifiableCredential', and one of the items MUST be the URI 'EndorsementCredential'.",
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"@context",
"type",
"id",
"name",
"credentialSubject",
"issuer",
"issuanceDate"
],
"type": "object"
},
"EndorsementSubject": {
"additionalProperties": true,
"description": "A collection of information about the subject of the endorsement.",
"properties": {
"endorsementComment": {
"$comment": "Origin: Markdown (DerivedType); A `String` that may contain Markdown.",
"description": "Allows endorsers to make a simple claim in writing about the entity.",
"type": "string"
},
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "The identifier of the individual, entity, organization, assertion, or achievement that is endorsed.",
"type": "string"
},
"type": {
"oneOf": [
{
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the URI 'VerifiableCredential', and one of the items MUST be the URI 'EndorsementSubject'.",
"type": "string"
},
{
"items": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the URI 'VerifiableCredential', and one of the items MUST be the URI 'EndorsementSubject'.",
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"Evidence": {
"additionalProperties": true,
"description": "Descriptive metadata about evidence related to the achievement assertion. Each instance of the evidence class present in an assertion corresponds to one entity, though a single entry can describe a set of items collectively. There may be multiple evidence entries referenced from an assertion. The narrative property is also in scope of the assertion class to provide an overall description of the achievement related to the assertion in rich text. It is used here to provide a narrative of achievement of the specific entity described. If both the description and narrative properties are present, displayers can assume the narrative value goes into more detail and is not simply a recapitulation of description.",
"properties": {
"audience": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A description of the intended audience for a piece of evidence.",
"type": "string"
},
"description": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A longer description of the evidence.",
"type": "string"
},
"genre": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A string that describes the type of evidence. For example, Poetry, Prose, Film.",
"type": "string"
},
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "The URL of a webpage presenting evidence of achievement or the evidence encoded as a Data URI. The schema of the webpage is undefined.",
"type": "string"
},
"name": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A descriptive title of the evidence.",
"type": "string"
},
"narrative": {
"$comment": "Origin: Markdown (DerivedType); A `String` that may contain Markdown.",
"description": "A narrative that describes the evidence and process of achievement that led to an assertion.",
"type": "string"
},
"type": {
"oneOf": [
{
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'Evidence'.",
"type": "string"
},
{
"items": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'Evidence'.",
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"type"
],
"type": "object"
},
"GeoCoordinates": {
"additionalProperties": true,
"description": "The geographic coordinates of a location.",
"properties": {
"latitude": {
"$comment": "Origin: Float (PrimitiveType)",
"description": "The latitude of the location [[WGS84]].",
"type": "number"
},
"longitude": {
"$comment": "Origin: Float (PrimitiveType)",
"description": "The longitude of the location [[WGS84]].",
"type": "number"
},
"type": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'GeoCoordinates'.",
"type": "string"
}
},
"required": [
"type",
"latitude",
"longitude"
],
"type": "object"
},
"IdentifierEntry": {
"additionalProperties": false,
"description": "No description supplied.",
"properties": {
"identifier": {
"$comment": "Origin: Identifier (DerivedType); A `NormalizedString` that functions as an identifier.",
"description": "An identifier.",
"type": "string"
},
"identifierType": {
"$comment": "Origin: IdentifierTypeEnum (EnumExt)",
"anyOf": [
{
"enum": [
"name",
"sourcedId",
"systemId",
"productId",
"userName",
"accountId",
"emailAddress",
"nationalIdentityNumber",
"isbn",
"issn",
"lisSourcedId",
"oneRosterSourcedId",
"sisSourcedId",
"ltiContextId",
"ltiDeploymentId",
"ltiToolId",
"ltiPlatformId",
"ltiUserId",
"identifier"
],
"type": "string"
},
{
"pattern": "(ext:)[a-z|A-Z|0-9|.|-|_]+",
"type": "string"
}
],
"description": "The identifier type."
},
"type": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'IdentifierEntry'.",
"type": "string"
}
},
"required": [
"type",
"identifier",
"identifierType"
],
"type": "object"
},
"IdentityObject": {
"additionalProperties": false,
"description": "A collection of information about the recipient of an achievement.",
"properties": {
"hashed": {
"$comment": "Origin: Boolean (PrimitiveType); A boolean, expressed as `true` or `false`",
"description": "Whether or not the `identityHash` value is hashed.",
"type": "boolean"
},
"identityHash": {
"$comment": "Origin: IdentityHash (DerivedType); A `String` consisting of an algorithm identifier, a `$` separator, and a hash across an identifier and an optionally appended salt string. The only supported algorithms are MD5 [[RFC1321]] and SHA-256 [[FIPS-180-4]], identified by the strings 'md5' and 'sha256' respectively. Identifiers and salts MUST be encoded in UTF-8 prior to hashing, and the resulting hash MUST be expressed in hexadecimal using uppercase (A-F, 0-9) or lowercase character (a-f, 0-9) sets. For example: 'sha256$b5809d8a92f8858436d7e6b87c12ebc0ae1eac4baecc2c0b913aee2c922ef399' represents the result of calculating a SHA-256 hash on the string '[email protected]'. in which the email identifier '[email protected]' is salted with 'Kosher'",
"description": "Either the IdentityHash of the identity or the plaintext value. If it's possible that the plaintext transmission and storage of the identity value would leak personally identifiable information where there is an expectation of privacy, it is strongly recommended that an IdentityHash be used.",
"type": "string"
},
"identityType": {
"$comment": "Origin: IdentifierTypeEnum (EnumExt)",
"anyOf": [
{
"enum": [
"name",
"sourcedId",
"systemId",
"productId",
"userName",
"accountId",
"emailAddress",
"nationalIdentityNumber",
"isbn",
"issn",
"lisSourcedId",
"oneRosterSourcedId",
"sisSourcedId",
"ltiContextId",
"ltiDeploymentId",
"ltiToolId",
"ltiPlatformId",
"ltiUserId",
"identifier"
],
"type": "string"
},
{
"pattern": "(ext:)[a-z|A-Z|0-9|.|-|_]+",
"type": "string"
}
],
"description": "The identity type."
},
"salt": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "If the `identityHash` is hashed, this should contain the string used to salt the hash. If this value is not provided, it should be assumed that the hash was not salted.",
"type": "string"
},
"type": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "MUST be the IRI 'IdentityObject'.",
"type": "string"
}
},
"required": [
"type",
"hashed",
"identityHash",
"identityType"
],
"type": "object"
},
"Image": {
"additionalProperties": false,
"description": "Metadata about images that represent assertions, achieve or profiles. These properties can typically be represented as just the id string of the image, but using a fleshed-out document allows for including captions and other applicable metadata.",
"properties": {
"caption": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The caption for the image.",
"type": "string"
},
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "The URI or Data URI of the image.",
"type": "string"
},
"type": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "MUST be the IRI 'Image'.",
"type": "string"
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"Profile": {
"additionalProperties": true,
"description": "A Profile is a collection of information that describes the entity or organization using Open Badges. Issuers must be represented as Profiles, and endorsers, or other entities may also be represented using this vocabulary. Each Profile that represents an Issuer may be referenced in many BadgeClasses that it has defined. Anyone can create and host an Issuer file to start issuing Open Badges. Issuers may also serve as recipients of Open Badges, often identified within an Assertion by specific properties, like their url or contact email address.",
"properties": {
"additionalName": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Additional name. Includes what is often referred to as 'middle name' in the western world.",
"type": "string"
},
"address": {
"$ref": "#/$defs/Address"
},
"dateOfBirth": {
"$comment": "Origin: Date (PrimitiveType); An [[ISO8601]] calendar date using the syntax YYYY-MM-DD.",
"description": "Birthdate of the person.",
"format": "date",
"type": "string"
},
"description": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A short description of the issuer entity or organization.",
"type": "string"
},
"email": {
"$comment": "Origin: EmailAddress (DerivedType); A `NormalizedString` representing an email address.",
"description": "An email address.",
"type": "string"
},
"endorsement": {
"items": {
"$ref": "#/$defs/EndorsementCredential"
},
"type": "array"
},
"endorsementJwt": {
"items": {
"$comment": "Origin: CompactJws (DerivedType); A `String` in Compact JWS format [[RFC7515]].",
"description": "Allows endorsers to make specific claims about the individual or organization represented by this profile. These endorsements are signed with the VC-JWT proof format.",
"pattern": "^[a-zA-Z0-9_-]+\\.[a-zA-Z0-9_-]*\\.[a-zA-Z0-9_-]+$",
"type": "string"
},
"type": "array"
},
"familyName": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Family name. In the western world, often referred to as the 'last name' of a person.",
"type": "string"
},
"familyNamePrefix": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Family name prefix. As used in some locales, this is the leading part of a family name (e.g. 'de' in the name 'de Boer').",
"type": "string"
},
"givenName": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Given name. In the western world, often referred to as the 'first name' of a person.",
"type": "string"
},
"honorificPrefix": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Honorific prefix(es) preceding a person's name (e.g. 'Dr', 'Mrs' or 'Mr').",
"type": "string"
},
"honorificSuffix": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Honorific suffix(es) following a person's name (e.g. 'M.D, PhD').",
"type": "string"
},
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "Unique URI for the Issuer/Profile file.",
"type": "string"
},
"image": {
"$ref": "#/$defs/Image"
},
"name": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The name of the entity or organization.",
"type": "string"
},
"official": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "If the entity is an organization, `official` is the name of an authorized official of the organization.",
"type": "string"
},
"otherIdentifier": {
"items": {
"$ref": "#/$defs/IdentifierEntry"
},
"type": "array"
},
"parentOrg": {
"$ref": "#/$defs/Profile"
},
"patronymicName": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Patronymic name.",
"type": "string"
},
"phone": {
"$comment": "Origin: PhoneNumber (DerivedType); A `NormalizedString` representing a phone number.",
"description": "A phone number.",
"type": "string"
},
"type": {
"oneOf": [
{
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'Profile'.",
"type": "string"
},
{
"items": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'Profile'.",
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
},
"url": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "The homepage or social media profile of the entity, whether individual or institutional. Should be a URL/URI Accessible via HTTP.",
"type": "string"
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"Proof": {
"additionalProperties": true,
"description": "A JSON-LD Linked Data proof.",
"properties": {
"challenge": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A value chosen by the verifier to mitigate authentication proof replay attacks.",
"type": "string"
},
"created": {
"$comment": "Origin: DateTime (PrimitiveType); An [[ISO8601]] time using the syntax YYYY-MM-DDThh:mm:ss.",
"description": "Date the proof was created.",
"format": "date-time",
"type": "string"
},
"cryptosuite": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The suite used to create the proof.",
"type": "string"
},
"domain": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The domain of the proof to restrict its use to a particular target.",
"type": "string"
},
"nonce": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A value chosen by the creator of proof to randomize proof values for privacy purposes.",
"type": "string"
},
"proofPurpose": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The purpose of the proof to be used with `verificationMethod`. MUST be 'assertionMethod'.",
"type": "string"
},
"proofValue": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Value of the proof.",
"type": "string"
},
"type": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "Signature suite used to produce proof.",
"type": "string"
},
"verificationMethod": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "The URL of the public key that can verify the signature.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"RefreshService": {
"additionalProperties": true,
"description": "The information in RefreshService is used to refresh the verifiable credential.",
"properties": {
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "The value MUST be the URL of the issuer's refresh service.",
"type": "string"
},
"type": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The name of the refresh service method.",
"type": "string"
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"Related": {
"additionalProperties": true,
"description": "Identifies a related achievement.",
"properties": {
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "The related achievement.",
"type": "string"
},
"inLanguage": {
"$comment": "Origin: LanguageCode (DerivedType); A language code [[BCP47]].",
"description": "The language of the related achievement.",
"pattern": "^[a-z]{2,4}(-[A-Z][a-z]{3})?(-([A-Z]{2}|[0-9]{3}))?$",
"type": "string"
},
"type": {
"oneOf": [
{
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'Related'.",
"type": "string"
},
{
"items": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'Related'.",
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
},
"version": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The version of the related achievement.",
"type": "string"
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"Result": {
"additionalProperties": true,
"description": "Describes a result that was achieved.",
"properties": {
"achievedLevel": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "If the result represents an achieved rubric criterion level (e.g. Mastered), the value is the `id` of the RubricCriterionLevel in linked ResultDescription.",
"type": "string"
},
"alignment": {
"items": {
"$ref": "#/$defs/Alignment"
},
"type": "array"
},
"resultDescription": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "An achievement can have many result descriptions describing possible results. The value of `resultDescription` is the `id` of the result description linked to this result. The linked result description must be in the achievement that is being asserted.",
"type": "string"
},
"status": {
"$comment": "Origin: ResultStatusType (Enumeration); Defined vocabulary to convey the status of an achievement.",
"description": "The status of the achievement. Required if `resultType` of the linked ResultDescription is Status.",
"enum": [
"Completed",
"Enrolled",
"Failed",
"InProgress",
"OnHold",
"Provisional",
"Withdrew"
],
"type": "string"
},
"type": {
"oneOf": [
{
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'Result'.",
"type": "string"
},
{
"items": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'Result'.",
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
},
"value": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A string representing the result of the performance, or demonstration, of the achievement. For example, 'A' if the recipient received an A grade in class.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"ResultDescription": {
"additionalProperties": true,
"description": "Describes a possible achievement result.",
"properties": {
"alignment": {
"items": {
"$ref": "#/$defs/Alignment"
},
"type": "array"
},
"allowedValue": {
"items": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "An ordered list of allowed values. The values should be ordered from low to high as determined by the achievement creator.",
"type": "string"
},
"type": "array"
},
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "The unique URI for this result description. Required so a result can link to this result description.",
"type": "string"
},
"name": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The name of the result.",
"type": "string"
},
"requiredLevel": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "The `id` of the rubric criterion level required to pass as determined by the achievement creator.",
"type": "string"
},
"requiredValue": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "A value from `allowedValue` or within the range of `valueMin` to `valueMax` required to pass as determined by the achievement creator.",
"type": "string"
},
"resultType": {
"$comment": "Origin: ResultType (EnumExt); The type of result. This is an extensible enumerated vocabulary. Extending the vocabulary makes use of a naming convention.",
"anyOf": [
{
"enum": [
"GradePointAverage",
"LetterGrade",
"Percent",
"PerformanceLevel",
"PredictedScore",
"RawScore",
"Result",
"RubricCriterion",
"RubricCriterionLevel",
"RubricScore",
"ScaledScore",
"Status"
],
"type": "string"
},
{
"pattern": "(ext:)[a-z|A-Z|0-9|.|-|_]+",
"type": "string"
}
],
"description": "The type of result this description represents. This is an extensible enumerated vocabulary."
},
"rubricCriterionLevel": {
"items": {
"$ref": "#/$defs/RubricCriterionLevel"
},
"type": "array"
},
"type": {
"oneOf": [
{
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'ResultDescription'.",
"type": "string"
},
{
"items": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'ResultDescription'.",
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
},
"valueMax": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The maximum possible `value` that may be asserted in a linked result.",
"type": "string"
},
"valueMin": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The minimum possible `value` that may be asserted in a linked result.",
"type": "string"
}
},
"required": [
"id",
"type",
"name",
"resultType"
],
"type": "object"
},
"RubricCriterionLevel": {
"additionalProperties": true,
"description": "Describes a rubric criterion level.",
"properties": {
"alignment": {
"items": {
"$ref": "#/$defs/Alignment"
},
"type": "array"
},
"description": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "Description of the rubric criterion level.",
"type": "string"
},
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "The unique URI for this rubric criterion level. Required so a result can link to this rubric criterion level.",
"type": "string"
},
"level": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The rubric performance level in terms of success.",
"type": "string"
},
"name": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The name of the rubric criterion level.",
"type": "string"
},
"points": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The points associated with this rubric criterion level.",
"type": "string"
},
"type": {
"oneOf": [
{
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'RubricCriterionLevel'.",
"type": "string"
},
{
"items": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the IRI 'RubricCriterionLevel'.",
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"id",
"type",
"name"
],
"type": "object"
},
"TermsOfUse": {
"additionalProperties": true,
"description": "Terms of use can be utilized by an issuer or a holder to communicate the terms under which a verifiable credential or verifiable presentation was issued",
"properties": {
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "The value MUST be a URI identifying the term of use.",
"type": "string"
},
"type": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value MUST identify the type of the terms of use.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"$id": "https://purl.imsglobal.org/spec/ob/v3p0/schema/json/ob_v3p0_achievementcredential_schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": true,
"description": "AchievementCredentials are representations of an awarded achievement, used to share information about a achievement belonging to one earner. Maps to a Verifiable Credential as defined in the [[VC-DATA-MODEL]]. As described in [[[#data-integrity]]], at least one proof mechanism, and the details necessary to evaluate that proof, MUST be expressed for a credential to be a verifiable credential. In the case of an embedded proof, the credential MUST append the proof in the `proof` property.",
"properties": {
"@context": {
"items": {
"$ref": "#/$defs/Context"
},
"minItems": 1,
"type": "array"
},
"awardedDate": {
"$comment": "Origin: DateTimeZ (DerivedType); A `DateTime` with the trailing timezone specifier included, e.g. `2021-09-07T02:09:59+02:00`",
"description": "Timestamp of when the credential was awarded. `issuanceDate` is used to determine the most recent version of a Credential in conjunction with `issuer` and `id`. Consequently, the only way to update a Credental is to update the `issuanceDate`, losing the date when the Credential was originally awarded. `awardedDate` is meant to keep this original date.",
"format": "date-time",
"type": "string"
},
"credentialSchema": {
"oneOf": [
{
"$ref": "#/$defs/CredentialSchema"
},
{
"items": {
"$ref": "#/$defs/CredentialSchema"
},
"type": "array"
}
]
},
"credentialStatus": {
"$ref": "#/$defs/CredentialStatus"
},
"credentialSubject": {
"$ref": "#/$defs/AchievementSubject"
},
"description": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The short description of the credential for display purposes in wallets.",
"type": "string"
},
"endorsement": {
"items": {
"$ref": "#/$defs/EndorsementCredential"
},
"type": "array"
},
"endorsementJwt": {
"items": {
"$comment": "Origin: CompactJws (DerivedType); A `String` in Compact JWS format [[RFC7515]].",
"description": "Allows endorsers to make specific claims about the credential, and the achievement and profiles in the credential. These endorsements are signed with the VC-JWT proof format.",
"pattern": "^[a-zA-Z0-9_-]+\\.[a-zA-Z0-9_-]*\\.[a-zA-Z0-9_-]+$",
"type": "string"
},
"type": "array"
},
"evidence": {
"items": {
"$ref": "#/$defs/Evidence"
},
"type": "array"
},
"expirationDate": {
"$comment": "Origin: DateTimeZ (DerivedType); A `DateTime` with the trailing timezone specifier included, e.g. `2021-09-07T02:09:59+02:00`",
"description": "If the credential has some notion of expiry, this indicates a timestamp when a credential should no longer be considered valid. After this time, the credential should be considered expired.",
"format": "date-time",
"type": "string"
},
"id": {
"$comment": "Origin: URI (DerivedType); A `NormalizedString` that respresents a Uniform Resource Identifier (URI).",
"description": "Unambiguous reference to the credential.",
"type": "string"
},
"image": {
"$ref": "#/$defs/Image"
},
"issuanceDate": {
"$comment": "Origin: DateTimeZ (DerivedType); A `DateTime` with the trailing timezone specifier included, e.g. `2021-09-07T02:09:59+02:00`",
"description": "Timestamp of when the credential was issued.",
"format": "date-time",
"type": "string"
},
"issuer": {
"$ref": "#/$defs/Profile"
},
"name": {
"$comment": "Origin: String (PrimitiveType); Character strings.",
"description": "The name of the credential for display purposes in wallets. For example, in a list of credentials and in detail views.",
"type": "string"
},
"proof": {
"oneOf": [
{
"$ref": "#/$defs/Proof"
},
{
"items": {
"$ref": "#/$defs/Proof"
},
"type": "array"
}
]
},
"refreshService": {
"$ref": "#/$defs/RefreshService"
},
"termsOfUse": {
"oneOf": [
{
"$ref": "#/$defs/TermsOfUse"
},
{
"items": {
"$ref": "#/$defs/TermsOfUse"
},
"type": "array"
}
]
},
"type": {
"oneOf": [
{
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the URI 'VerifiableCredential', and one of the items MUST be the URI 'AchievementCredential' or the URI 'OpenBadgeCredential'.",
"type": "string"
},
{
"items": {
"$comment": "Origin: IRI (DerivedType); A `NormalizedString` that represents an Internationalized Resource Identifier (IRI), which extends the ASCII characters subset of the Uniform Resource Identifier (URI).",
"description": "The value of the type property MUST be an unordered set. One of the items MUST be the URI 'VerifiableCredential', and one of the items MUST be the URI 'AchievementCredential' or the URI 'OpenBadgeCredential'.",
"type": "string"
},
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"@context",
"id",
"type",
"name",
"credentialSubject",
"issuer",
"issuanceDate"
],
"title": "JSON Schema for the AchievementCredential class.",
"type": "object"
} | Apache-2.0 | en |
GoogleCloudPlatform/opdio | 022143880eb8492e360276f8c3990bfa85c29fb2 | 2024-02-22T01:32:33 | api/schemas/omc-task.json | 8 | 2024-05-27T06:38:58.005247Z | {
"$comment": "Copyright 2021-2023 Motion Picture Laboratories, Inc.\nSPDX-License-Identifier: APACHE-2.0",
"$defs": {
"Task": {
"additionalProperties": false,
"properties": {
"Task": {
"additionalProperties": true,
"description": "A piece of work to be done and completed as a step in the production process.",
"properties": {
"Context": {
"$ref": "#/$defs/MediaCreationContext/properties/Context",
"title": "Asset Context"
},
"TaskSC": {
"$ref": "#/$defs/Task/properties/TaskSC",
"title": "Structural Characteristics"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A human readable description of the asset",
"title": "Asset description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Task",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier",
"title": "Identifier"
},
"name": {
"description": "A human readable name for the asset",
"title": "Asset name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"taskFC": {
"$ref": "#/$defs/Task/properties/taskFC",
"title": "Functional Characteristics"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Task",
"type": "object"
},
"TaskSC": {
"additionalProperties": true,
"description": "Describes the form of Task along with the attributes specific to that task\u2019s form",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "TaskSC",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"structuralProperties": {
"additionalProperties": true,
"description": "A set of properties that describe the asset in this form",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
}
},
"title": "Structural Properties",
"type": [
"object",
"null"
]
},
"structuralType": {
"description": "A structured description of the the assets form",
"examples": [
"assetGroup",
"digital.image",
"analog.movingImage"
],
"title": "Structural Type",
"type": [
"string",
"null"
]
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Task Structural Characteristics",
"type": "object"
},
"taskFC": {
"additionalProperties": true,
"description": "Describes the use or purpose of an Asset within the production process",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"functionalProperties": {
"additionalProperties": true,
"description": "A set of properties that describe the tasks functional use",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
}
},
"title": "Functional Properties",
"type": [
"object",
"null"
]
},
"functionalType": {
"description": "The use or purpose of a Task within the production process.",
"title": "Functional Type",
"type": [
"string",
"null"
]
}
},
"title": "Task Functional Characteristics",
"type": "object"
}
},
"title": "Task Definitions",
"type": "object"
},
"Utility": {
"additionalProperties": false,
"description": "Common data models and data structures used in multiple places and in multiple ways in a larger system.",
"properties": {
"Location": {
"additionalProperties": false,
"description": "A particular place or position either in either the real world or the narrative world.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": "array"
},
"address": {
"$ref": "#/$defs/Utility/properties/address",
"title": "Address"
},
"coordinates": {
"$ref": "#/$defs/Utility/properties/coordinates",
"title": "Coordinates"
},
"description": {
"description": "A brief description of the location",
"title": "Location Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Location",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier",
"title": "Identifier"
},
"name": {
"description": "A human readable name for the location",
"title": "Location name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Location",
"type": "object"
},
"address": {
"additionalProperties": false,
"description": "A postal address or identifiable location of a place or building",
"properties": {
"country": {
"$ref": "#/$defs/Utility/properties/country",
"title": "Country"
},
"locality": {
"description": "The locality in which the street address is, and which is in the region.",
"examples": [
"Mountain View"
],
"title": "Address locality",
"type": [
"string",
"null"
]
},
"postalCode": {
"description": "A zip or postal code",
"examples": [
"94534"
],
"title": "Zip or Postal Code",
"type": [
"string",
"null"
]
},
"region": {
"description": "The region in which the locality is, and which is in the country",
"examples": [
"California"
],
"title": "Address region",
"type": [
"string",
"null"
]
},
"street": {
"description": "The street address",
"examples": [
"1600 Amphitheater Parkway"
],
"title": "Street Address",
"type": [
"string",
"null"
]
}
},
"title": "Address",
"type": [
"object",
"null"
]
},
"basicName": {
"additionalProperties": false,
"description": "A description of things name and an alternative name",
"properties": {
"altName": {
"description": "An alternate, often shortened name for the entity",
"title": "Alternate Name",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full an complete name of the entity",
"title": "Full Name",
"type": [
"string",
"null"
]
}
},
"title": "Basic Name",
"type": [
"object",
"null"
]
},
"completeName": {
"additionalProperties": false,
"description": "A detailed description of a person, or others, name and variants of their name.",
"properties": {
"alias": {
"description": "An alias being used by a person often used to disguise someones real identity, sometimes used when booking hotel rooms or restaurants ",
"title": "Alias",
"type": [
"string",
"null"
]
},
"altName": {
"title": "Alternate Name",
"type": [
"string",
"null"
]
},
"birthName": {
"description": "A persons name at birth, also referred to as maiden name",
"title": "Birth Name",
"type": [
"string",
"null"
]
},
"contractualName": {
"title": "Contractual Name",
"type": [
"string",
"null"
]
},
"displayName": {
"title": "Display Name",
"type": [
"string",
"null"
]
},
"familyName": {
"description": "A persons family name, also referred to as surname",
"title": "Family Name",
"type": [
"string",
"null"
]
},
"firstGivenName": {
"description": "A person's first name, also referred to as given name",
"title": "First Given Name",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "A complete name, typically a conjunction of familyName, firstGivenName and possibly other fields.",
"title": "Full Name",
"type": [
"string",
"null"
]
},
"moniker": {
"title": "Moniker",
"type": [
"string",
"null"
]
},
"nickname": {
"title": "Nickname",
"type": [
"string",
"null"
]
},
"prefix": {
"description": "A prefix that can indicate a persons gender or title",
"examples": [
"Mrs",
"Mr",
"Dr",
"General"
],
"title": "Prefix",
"type": [
"string",
"null"
]
},
"primaryName": {
"description": "A persons primary name, one they typically use, also often a combination of first, second and family name",
"title": "Primary Name",
"type": [
"string",
"null"
]
},
"pseudonym": {
"title": "Pseudonym",
"type": [
"string",
"null"
]
},
"scriptName": {
"title": "Script Name",
"type": [
"string",
"null"
]
},
"secondGivenName": {
"description": "A persons second given name, also referred to as middle name",
"title": "Second Given Name",
"type": [
"string",
"null"
]
},
"sortName": {
"title": "Sort Name",
"type": [
"string",
"null"
]
},
"suffix": {
"description": "A suffix, often used to indicate a title or classification",
"examples": [
"MBE",
"MD",
"RN",
"II",
"IV"
],
"title": "Suffix",
"type": [
"string",
"null"
]
},
"translatedName": {
"title": "Translated Name",
"type": [
"string",
"null"
]
}
},
"title": "Complete Name",
"type": "object"
},
"contact": {
"additionalProperties": false,
"properties": {
"email": {
"$ref": "#/$defs/Utility/properties/email",
"title": "Email"
},
"telephone": {
"$ref": "#/$defs/Utility/properties/telephone",
"title": "Telephone"
}
},
"title": "Contact",
"type": "object"
},
"coordinates": {
"additionalProperties": false,
"description": "A global positioning coordinate in compliance with WGS 84",
"properties": {
"latitude": {
"maximum": 90,
"minimum": -90,
"title": "latitude",
"type": "number"
},
"longitude": {
"maximum": 180,
"minimum": -180,
"title": "longitude",
"type": "number"
}
},
"title": "Coordinates",
"type": [
"object",
"null"
]
},
"country": {
"description": "The country, as an ISO 3166-1 alpha-2 country code",
"examples": [
"US"
],
"maxLength": 2,
"minLength": 2,
"title": "Country",
"type": [
"string",
"null"
]
},
"email": {
"additionalProperties": false,
"properties": {
"business": {
"title": "Business",
"type": [
"string",
"null"
]
},
"personal": {
"title": "Personal",
"type": [
"string",
"null"
]
}
},
"title": "Email",
"type": "object"
},
"gender": {
"additionalProperties": false,
"description": "A person, or others, expressed or prefered gender and pronoun",
"properties": {
"gender": {
"description": "The gender by which an individual identifies",
"enum": [
"male",
"female",
"other",
"unknown",
null
],
"title": "Identifies as gender",
"type": [
"string",
"null"
]
},
"genderPronoun": {
"description": "An individuals pronoun of choice",
"enum": [
"he/him",
"she/her",
"ze/hir",
"they/their",
null
],
"title": "Preferred pronoun",
"type": [
"string",
"null"
]
}
},
"title": "Gender",
"type": [
"object",
"null"
]
},
"identifier": {
"description": "An identifier uniquely identifies an entity within a particular scope.",
"items": {
"additionalProperties": false,
"properties": {
"combinedForm": {
"description": "A combination of the Identifier Scope and Value that is useful for utilizing the identifier in a system, for example a URN (URN:ID:IdentifierScope:IdentifierValue).",
"title": "Identifier Combined Form",
"type": "string"
},
"identifierScope": {
"description": "The universe within which an identifier is valid and unique.",
"title": "Identifier Scope",
"type": "string"
},
"identifierValue": {
"description": "A string of characters that uniquely identifies an object within a particular scope.",
"title": "Identifier Value",
"type": "string"
},
"url": {
"description": "A URL or IRI that can be used for resolving the Identifier Value within the Identifier Scope.",
"title": "URL",
"type": "string"
}
},
"required": [
"identifierScope",
"identifierValue"
],
"type": "object"
},
"minItems": 1,
"title": "Identifier",
"type": "array"
},
"language": {
"description": "An IETF BCP 47 language code",
"title": "Language",
"type": [
"string",
"null"
]
},
"note": {
"additionalProperties": false,
"properties": {
"text": {
"description": "The text of the note or annotation",
"title": "Text",
"type": "string"
},
"title": {
"description": "A title for the note or annotation",
"title": "Title",
"type": "string"
}
},
"title": "Note",
"type": [
"object",
"null"
]
},
"telephone": {
"additionalProperties": false,
"properties": {
"business": {
"title": "Business",
"type": [
"string",
"null"
]
},
"personal": {
"title": "Personal",
"type": [
"string",
"null"
]
}
},
"title": "Telephone",
"type": "object"
},
"time": {
"additionalProperties": false,
"properties": {
"date": {
"description": "Should be formatted to comply with ISO 8601",
"examples": [
"2020-11-21"
],
"pattern": "\\d{4}-[01]\\d-[0-3]\\d",
"title": "Date",
"type": [
"string",
"null"
]
},
"dateTime": {
"description": "Should be formatted to comply with ISO 8601",
"examples": [
"2023-08-24T20:51:15Z\n2023-08-24T20:51:15.56Z\n2023-08-24T20:51:15+08:00\n2023-08-24T20:51:15.23-04:00"
],
"pattern": "^(?:19|20)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:|\\.\\d\\d)(?:Z|-0[1-9]|-1\\d|-2[0-3]|-00:?(?:0[1-9]|[1-5]\\d)|\\+[01]\\d|\\+2[0-3])(?:|:?[0-5]\\d)$",
"title": "Date & Time",
"type": [
"string",
"null"
]
},
"descriptiveTime": {
"additionalProperties": false,
"properties": {
"eventInTime": {
"description": "Describes a specific event that occurred",
"examples": [
"Hindenburg disaster",
"World Trade Center attack",
"Queen Elizabeth coronation"
],
"title": "Event in Time",
"type": "string"
},
"periodInDay": {
"examples": [
"Morning",
"Noon",
"Midnight",
"Afternoon",
"Night"
],
"title": "Period in Day",
"type": "string"
},
"periodInTime": {
"examples": [
"Ming dynasty",
"World War II",
"Jurassic period",
"20th century"
],
"title": "Period in Time",
"type": "string"
},
"relativeTime": {
"examples": [
"Later",
"Continuous",
"6 months earlier",
"A long time ago"
],
"title": "Relative Time",
"type": "string"
}
},
"title": "Descriptive Time",
"type": "object"
},
"durationTime": {
"description": "Should be formatted to comply with ISO 8601",
"examples": [
"P2Y12M3D"
],
"pattern": "^(-?)P(?=.)((\\d+)Y)?((\\d+)M)?((\\d+)D)?(T(?=.)((\\d+)H)?((\\d+)M)?(\\d*(\\.\\d+)?S)?)?$",
"title": "Duration of Time",
"type": [
"string",
"null"
]
},
"periodInTime": {
"additionalProperties": false,
"properties": {
"durationTime": {
"title": "Duration of Time",
"type": "string"
},
"endTime": {
"title": "End Time",
"type": "string"
},
"startTime": {
"title": "Start Time",
"type": "string"
}
},
"required": [
"startTime"
],
"title": "Period in Time",
"type": "object"
},
"timecode": {
"description": "SMPTE timecode",
"examples": [
"00:03:43:12"
],
"pattern": "^(?:(?:[0-1][0-9]|[0-2][0-3]):)(?:[0-5][0-9]:){2}(?:[0-2][0-9])$",
"title": "SMPTE Timcode in the format HH:MM:SS:FF. \nAssumes the frame rate is 23.98, 24, 25, 29.97 NDF, or 30",
"type": [
"string",
"null"
]
},
"timestamp": {
"title": "Timestamp",
"type": [
"number",
"null"
]
}
},
"title": "Time",
"type": "object"
},
"unitOfMeasurement": {
"additionalProperties": false,
"properties": {
"dimensions": {
"description": "Encode a set of measurements to describe a 2 or 3 dimensional object (metric, imperial or pixels)",
"properties": {
"depth": {
"description": "The depth or Z axis of the object",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode distance using the metric system of measurement (kilometer, meter, centimetre, millimeter",
"examples": [
"100m",
"6km2m56cm12mm"
],
"pattern": "^-?(\\d+km)?(\\d+m)?(\\d+cm)?(\\d+mm)?$",
"type": "string"
},
{
"description": "Encode distance using the imperial system of measurement (miles, feet, inches)",
"examples": [
"2000ft",
"2mi12ft6in"
],
"pattern": "^-?(\\d+mi)?(\\d+ft)?(\\d+in)?$",
"type": "string"
},
{
"description": "Encode a measurement of the number of pixels, typically in a digital image",
"examples": [
"250px"
],
"pattern": "^(\\d+px)$",
"type": "string"
}
]
},
"height": {
"description": "The height or X axis of the object",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode distance using the metric system of measurement (kilometer, meter, centimetre, millimeter",
"examples": [
"100m",
"6km2m56cm12mm"
],
"pattern": "^-?(\\d+km)?(\\d+m)?(\\d+cm)?(\\d+mm)?$",
"type": "string"
},
{
"description": "Encode distance using the imperial system of measurement (miles, feet, inches)",
"examples": [
"2000ft",
"2mi12ft6in"
],
"pattern": "^-?(\\d+mi)?(\\d+ft)?(\\d+in)?$",
"type": "string"
},
{
"description": "Encode a measurement of the number of pixels, typically in a digital image",
"examples": [
"250px"
],
"pattern": "^(\\d+px)$",
"type": "string"
}
]
},
"width": {
"description": "The width or X axis of the object",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode distance using the metric system of measurement (kilometer, meter, centimetre, millimeter",
"examples": [
"100m",
"6km2m56cm12mm"
],
"pattern": "^-?(\\d+km)?(\\d+m)?(\\d+cm)?(\\d+mm)?$",
"type": "string"
},
{
"description": "Encode distance using the imperial system of measurement (miles, feet, inches)",
"examples": [
"2000ft",
"2mi12ft6in"
],
"pattern": "^-?(\\d+mi)?(\\d+ft)?(\\d+in)?$",
"type": "string"
},
{
"description": "Encode a measurement of the number of pixels, typically in a digital image",
"examples": [
"250px"
],
"pattern": "^(\\d+px)$",
"type": "string"
}
]
}
},
"title": "dimensions",
"type": "object"
},
"linearDistance": {
"description": "Encode a measurement of distance using the imperial or metric system",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode distance using the metric system of measurement (kilometer, meter, centimetre, millimeter",
"examples": [
"100m",
"6km2m56cm12mm"
],
"pattern": "^-?(\\d+km)?(\\d+m)?(\\d+cm)?(\\d+mm)?$",
"type": "string"
},
{
"description": "Encode distance using the imperial system of measurement (miles, feet, inches)",
"examples": [
"2000ft",
"2mi12ft6in"
],
"pattern": "^-?(\\d+mi)?(\\d+ft)?(\\d+in)?$",
"type": "string"
}
],
"title": "Linear Distance"
},
"weight": {
"description": "Encode a measurement of weight using the imperial or metric system",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode weight using the metric system of measurement (kilogram, gram)",
"examples": [
"3kg7g"
],
"pattern": "^(\\d+kg)?(\\d+g)?$",
"type": "string"
},
{
"description": "Encode weight using the imperial system of measurement (pounds, ounces)",
"examples": [
"12lb14oz"
],
"pattern": "^(\\d+lb)?(\\d+oz)?$",
"type": "string"
}
],
"title": "weight"
}
},
"type": "object"
},
"versionNumber": {
"description": "A designation indicating a place in a sequence of versions",
"title": "Version Number",
"type": [
"string",
"number",
"null"
]
}
},
"title": "Utility Definitions",
"type": "object"
},
"core": {
"additionalProperties": false,
"description": "Helper objects used in building the schema",
"properties": {
"customData": {
"additionalProperties": true,
"description": "A user defined set of custom data in the payload of the instance, used where the formal schema lacks required properties",
"title": "Custom Data",
"type": "object"
},
"entityInfo": {
"additionalProperties": false,
"description": "Reserved for future use to describe specific details about the instance of the entity",
"title": "Entity Information",
"type": [
"object",
"null"
]
},
"reference": {
"additionalProperties": false,
"description": "An identifier that references another entity in the graph",
"properties": {
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
}
},
"title": "Reference entity",
"type": [
"object",
"null"
]
},
"rootArray": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Character"
},
{
"$ref": "#/$defs/Participant/properties/Participant"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeAudio"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionLocation"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Slate"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Effect"
},
{
"$ref": "#/$defs/Utility/properties/Location"
},
{
"$ref": "#/$defs/Participant/properties/Role"
},
{
"$ref": "#/$defs/Participant/properties/Person"
},
{
"$ref": "#/$defs/Participant/properties/Department"
},
{
"$ref": "#/$defs/Participant/properties/Organization"
},
{
"$ref": "#/$defs/Participant/properties/Service"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
},
{
"$ref": "#/$defs/Infrastructure/properties/Infrastructure"
},
{
"$ref": "#/$defs/Infrastructure/properties/InfrastructureSC"
},
{
"$ref": "#/$defs/Task/properties/Task"
},
{
"$ref": "#/$defs/Task/properties/TaskSC"
}
]
},
"type": "array"
},
"rootObject": {
"additionalProperties": false,
"properties": {
"Asset": {
"items": {
"$ref": "#/$defs/Asset/properties/Asset"
},
"title": "Asset",
"type": "array"
},
"AssetSC": {
"items": {
"$ref": "#/$defs/Asset/properties/AssetSC"
},
"title": "Asset Structural Characteristics",
"type": "array"
},
"Character": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Character"
},
"title": "Character",
"type": "array"
},
"Context": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Context"
},
"title": "Context",
"type": "array"
},
"CreativeWork": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
},
"title": "Creative Work",
"type": "array"
},
"Department": {
"items": {
"$ref": "#/$defs/Participant/properties/Department"
},
"title": "Department",
"type": "array"
},
"Depiction": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
},
"title": "Context",
"type": "array"
},
"Effect": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Effect"
},
"title": "Effect",
"type": "array"
},
"Location": {
"items": {
"$ref": "#/$defs/Utility/properties/Location"
},
"title": "Location",
"type": "array"
},
"NarrativeAudio": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeAudio"
},
"title": "Narrative Audio",
"type": "array"
},
"NarrativeLocation": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
"title": "Narrative Location",
"type": "array"
},
"NarrativeObject": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject"
},
"title": "Narrative Object",
"type": "array"
},
"NarrativeScene": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene"
},
"title": "Narrative Scene",
"type": "array"
},
"NarrativeStyling": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling"
},
"title": "Narrative Styling",
"type": "array"
},
"NarrativeWardrobe": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe"
},
"title": "Narrative Wardrobe",
"type": "array"
},
"Organization": {
"items": {
"$ref": "#/$defs/Participant/properties/Organization"
},
"title": "Organization",
"type": "array"
},
"Participant": {
"items": {
"$ref": "#/$defs/Participant/properties/Participant"
},
"title": "Participant",
"type": "array"
},
"Person": {
"items": {
"$ref": "#/$defs/Participant/properties/Person"
},
"title": "Person",
"type": "array"
},
"ProductionLocation": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/ProductionLocation"
},
"title": "Production Location",
"type": "array"
},
"ProductionScene": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene"
},
"title": "Production Scene",
"type": "array"
},
"Role": {
"items": {
"$ref": "#/$defs/Participant/properties/Role"
},
"title": "Service",
"type": "array"
},
"Sequence": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
},
"title": "Sequence",
"type": "array"
},
"Service": {
"items": {
"$ref": "#/$defs/Participant/properties/Service"
},
"title": "Service",
"type": "array"
},
"Slate": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Slate"
},
"title": "Slate",
"type": "array"
},
"SpecialAction": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction"
},
"title": "Special Action",
"type": "array"
}
},
"type": "object"
},
"schemaVersion": {
"default": "https://movielabs.com/omc/json/schema/v2.0",
"description": "Describes the version of OMC-JSON schema that was used to create this instance",
"enum": [
"https://movielabs.com/omc/json/schema/v2.0"
],
"title": "Schema Version",
"type": "string"
}
},
"title": "Core",
"type": "object"
}
},
"$id": "https://movielabs.com/omc/json/schema/v2.0",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"oneOf": [
{
"$ref": "#/$defs/core/properties/rootObject"
},
{
"$ref": "#/$defs/core/properties/rootArray"
}
],
"title": "OMC-JSON schema v2.0"
} | Apache-2.0 | en |
GoogleCloudPlatform/opdio | dab11b10d2c134ba72e1a8baa5af0b73ca6f05ba | 2024-02-18T21:44:02 | api/schemas/omc-infrastructure.json | 8 | 2024-05-27T06:38:58.005247Z | {
"$comment": "Copyright 2021-2023 Motion Picture Laboratories, Inc.\nSPDX-License-Identifier: APACHE-2.0",
"$defs": {
"Infrastructure": {
"additionalProperties": false,
"properties": {
"Infrastructure": {
"additionalProperties": true,
"description": "The underlying systems and framework required for the production of the Creative Work; it is generally not specific to a particular Creative Work.",
"properties": {
"Context": {
"$ref": "#/$defs/MediaCreationContext/properties/Context",
"title": "Asset Context"
},
"InfrastructureSC": {
"$ref": "#/$defs/Infrastructure/properties/InfrastructureSC",
"title": "Structural Characteristics"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A human readable description of the asset",
"title": "Asset description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Infrastructure",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier",
"title": "Identifier"
},
"infrastructureFC": {
"$ref": "#/$defs/Infrastructure/properties/infrastructureFC",
"title": "Functional Characteristics"
},
"name": {
"description": "A human readable name for the asset",
"title": "Asset name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Infrastructure",
"type": "object"
},
"InfrastructureSC": {
"additionalProperties": false,
"description": "Describes the form of the Infrastructure along with the attributes specific to that infrastructure's form",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"entityType": {
"const": "InfrastructureSC",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"structuralProperties": {
"additionalProperties": true,
"description": "A set of properties that describe the infrastructure in this form",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
}
},
"title": "Structural Properties",
"type": [
"object",
"null"
]
},
"structuralType": {
"description": "A structured description of the the assets form",
"examples": [
"assetGroup",
"digital.image",
"analog.movingImage"
],
"title": "Structural Type",
"type": [
"string",
"null"
]
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Infrastructure Structural Characteristics",
"type": "object"
},
"infrastructureFC": {
"additionalProperties": true,
"description": "Describes the use or purpose of an Infrastructure within the production process",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"functionalProperties": {
"additionalProperties": true,
"description": "A set of properties that describe the tasks functional use",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
}
},
"title": "Functional Properties",
"type": [
"object",
"null"
]
},
"functionalType": {
"description": "The use or purpose of a Task within the production process.",
"title": "Functional Type",
"type": [
"string",
"null"
]
}
},
"title": "Infrastructure Functional Characteristics",
"type": "object"
}
},
"title": "Infrastructure Definitions",
"type": "object"
},
"Utility": {
"additionalProperties": false,
"description": "Common data models and data structures used in multiple places and in multiple ways in a larger system.",
"properties": {
"Location": {
"additionalProperties": false,
"description": "A particular place or position either in either the real world or the narrative world.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": "array"
},
"address": {
"$ref": "#/$defs/Utility/properties/address",
"title": "Address"
},
"coordinates": {
"$ref": "#/$defs/Utility/properties/coordinates",
"title": "Coordinates"
},
"description": {
"description": "A brief description of the location",
"title": "Location Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Location",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier",
"title": "Identifier"
},
"name": {
"description": "A human readable name for the location",
"title": "Location name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Location",
"type": "object"
},
"address": {
"additionalProperties": false,
"description": "A postal address or identifiable location of a place or building",
"properties": {
"country": {
"$ref": "#/$defs/Utility/properties/country",
"title": "Country"
},
"locality": {
"description": "The locality in which the street address is, and which is in the region.",
"examples": [
"Mountain View"
],
"title": "Address locality",
"type": [
"string",
"null"
]
},
"postalCode": {
"description": "A zip or postal code",
"examples": [
"94534"
],
"title": "Zip or Postal Code",
"type": [
"string",
"null"
]
},
"region": {
"description": "The region in which the locality is, and which is in the country",
"examples": [
"California"
],
"title": "Address region",
"type": [
"string",
"null"
]
},
"street": {
"description": "The street address",
"examples": [
"1600 Amphitheater Parkway"
],
"title": "Street Address",
"type": [
"string",
"null"
]
}
},
"title": "Address",
"type": [
"object",
"null"
]
},
"basicName": {
"additionalProperties": false,
"description": "A description of things name and an alternative name",
"properties": {
"altName": {
"description": "An alternate, often shortened name for the entity",
"title": "Alternate Name",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full an complete name of the entity",
"title": "Full Name",
"type": [
"string",
"null"
]
}
},
"title": "Basic Name",
"type": [
"object",
"null"
]
},
"completeName": {
"additionalProperties": false,
"description": "A detailed description of a person, or others, name and variants of their name.",
"properties": {
"alias": {
"description": "An alias being used by a person often used to disguise someones real identity, sometimes used when booking hotel rooms or restaurants ",
"title": "Alias",
"type": [
"string",
"null"
]
},
"altName": {
"title": "Alternate Name",
"type": [
"string",
"null"
]
},
"birthName": {
"description": "A persons name at birth, also referred to as maiden name",
"title": "Birth Name",
"type": [
"string",
"null"
]
},
"contractualName": {
"title": "Contractual Name",
"type": [
"string",
"null"
]
},
"displayName": {
"title": "Display Name",
"type": [
"string",
"null"
]
},
"familyName": {
"description": "A persons family name, also referred to as surname",
"title": "Family Name",
"type": [
"string",
"null"
]
},
"firstGivenName": {
"description": "A person's first name, also referred to as given name",
"title": "First Given Name",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "A complete name, typically a conjunction of familyName, firstGivenName and possibly other fields.",
"title": "Full Name",
"type": [
"string",
"null"
]
},
"moniker": {
"title": "Moniker",
"type": [
"string",
"null"
]
},
"nickname": {
"title": "Nickname",
"type": [
"string",
"null"
]
},
"prefix": {
"description": "A prefix that can indicate a persons gender or title",
"examples": [
"Mrs",
"Mr",
"Dr",
"General"
],
"title": "Prefix",
"type": [
"string",
"null"
]
},
"primaryName": {
"description": "A persons primary name, one they typically use, also often a combination of first, second and family name",
"title": "Primary Name",
"type": [
"string",
"null"
]
},
"pseudonym": {
"title": "Pseudonym",
"type": [
"string",
"null"
]
},
"scriptName": {
"title": "Script Name",
"type": [
"string",
"null"
]
},
"secondGivenName": {
"description": "A persons second given name, also referred to as middle name",
"title": "Second Given Name",
"type": [
"string",
"null"
]
},
"sortName": {
"title": "Sort Name",
"type": [
"string",
"null"
]
},
"suffix": {
"description": "A suffix, often used to indicate a title or classification",
"examples": [
"MBE",
"MD",
"RN",
"II",
"IV"
],
"title": "Suffix",
"type": [
"string",
"null"
]
},
"translatedName": {
"title": "Translated Name",
"type": [
"string",
"null"
]
}
},
"title": "Complete Name",
"type": "object"
},
"contact": {
"additionalProperties": false,
"properties": {
"email": {
"$ref": "#/$defs/Utility/properties/email",
"title": "Email"
},
"telephone": {
"$ref": "#/$defs/Utility/properties/telephone",
"title": "Telephone"
}
},
"title": "Contact",
"type": "object"
},
"coordinates": {
"additionalProperties": false,
"description": "A global positioning coordinate in compliance with WGS 84",
"properties": {
"latitude": {
"maximum": 90,
"minimum": -90,
"title": "latitude",
"type": "number"
},
"longitude": {
"maximum": 180,
"minimum": -180,
"title": "longitude",
"type": "number"
}
},
"title": "Coordinates",
"type": [
"object",
"null"
]
},
"country": {
"description": "The country, as an ISO 3166-1 alpha-2 country code",
"examples": [
"US"
],
"maxLength": 2,
"minLength": 2,
"title": "Country",
"type": [
"string",
"null"
]
},
"email": {
"additionalProperties": false,
"properties": {
"business": {
"title": "Business",
"type": [
"string",
"null"
]
},
"personal": {
"title": "Personal",
"type": [
"string",
"null"
]
}
},
"title": "Email",
"type": "object"
},
"gender": {
"additionalProperties": false,
"description": "A person, or others, expressed or prefered gender and pronoun",
"properties": {
"gender": {
"description": "The gender by which an individual identifies",
"enum": [
"male",
"female",
"other",
"unknown",
null
],
"title": "Identifies as gender",
"type": [
"string",
"null"
]
},
"genderPronoun": {
"description": "An individuals pronoun of choice",
"enum": [
"he/him",
"she/her",
"ze/hir",
"they/their",
null
],
"title": "Preferred pronoun",
"type": [
"string",
"null"
]
}
},
"title": "Gender",
"type": [
"object",
"null"
]
},
"identifier": {
"description": "An identifier uniquely identifies an entity within a particular scope.",
"items": {
"additionalProperties": false,
"properties": {
"combinedForm": {
"description": "A combination of the Identifier Scope and Value that is useful for utilizing the identifier in a system, for example a URN (URN:ID:IdentifierScope:IdentifierValue).",
"title": "Identifier Combined Form",
"type": "string"
},
"identifierScope": {
"description": "The universe within which an identifier is valid and unique.",
"title": "Identifier Scope",
"type": "string"
},
"identifierValue": {
"description": "A string of characters that uniquely identifies an object within a particular scope.",
"title": "Identifier Value",
"type": "string"
},
"url": {
"description": "A URL or IRI that can be used for resolving the Identifier Value within the Identifier Scope.",
"title": "URL",
"type": "string"
}
},
"required": [
"identifierScope",
"identifierValue"
],
"type": "object"
},
"minItems": 1,
"title": "Identifier",
"type": "array"
},
"language": {
"description": "An IETF BCP 47 language code",
"title": "Language",
"type": [
"string",
"null"
]
},
"note": {
"additionalProperties": false,
"properties": {
"text": {
"description": "The text of the note or annotation",
"title": "Text",
"type": "string"
},
"title": {
"description": "A title for the note or annotation",
"title": "Title",
"type": "string"
}
},
"title": "Note",
"type": [
"object",
"null"
]
},
"provenance": {
"additionalProperties": false,
"description": "A record of when something was changed and by whom.",
"properties": {
"CreatedBy": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Participant/properties/Participant"
}
]
},
"Origin": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"Role": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Participant/properties/Role"
}
]
},
"createdOn": {
"$ref": "#/$defs/Utility/properties/time/properties/dateTime"
},
"note": {
"items": {
"$ref": "#/$defs/Utility/properties/note"
},
"type": "array"
},
"reason": {
"type": "string"
}
},
"title": "Provenance",
"type": "object"
},
"telephone": {
"additionalProperties": false,
"properties": {
"business": {
"title": "Business",
"type": [
"string",
"null"
]
},
"personal": {
"title": "Personal",
"type": [
"string",
"null"
]
}
},
"title": "Telephone",
"type": "object"
},
"time": {
"additionalProperties": false,
"properties": {
"date": {
"description": "Should be formatted to comply with ISO 8601",
"examples": [
"2020-11-21"
],
"pattern": "\\d{4}-[01]\\d-[0-3]\\d",
"title": "Date",
"type": [
"string",
"null"
]
},
"dateTime": {
"description": "Should be formatted to comply with ISO 8601",
"examples": [
"2023-08-24T20:51:15Z\n2023-08-24T20:51:15.56Z\n2023-08-24T20:51:15+08:00\n2023-08-24T20:51:15.23-04:00"
],
"pattern": "^(?:19|20)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:|\\.\\d\\d)(?:Z|-0[1-9]|-1\\d|-2[0-3]|-00:?(?:0[1-9]|[1-5]\\d)|\\+[01]\\d|\\+2[0-3])(?:|:?[0-5]\\d)$",
"title": "Date & Time",
"type": [
"string",
"null"
]
},
"descriptiveTime": {
"additionalProperties": false,
"properties": {
"eventInTime": {
"description": "Describes a specific event that occurred",
"examples": [
"Hindenburg disaster",
"World Trade Center attack",
"Queen Elizabeth coronation"
],
"title": "Event in Time",
"type": "string"
},
"periodInDay": {
"examples": [
"Morning",
"Noon",
"Midnight",
"Afternoon",
"Night"
],
"title": "Period in Day",
"type": "string"
},
"periodInTime": {
"examples": [
"Ming dynasty",
"World War II",
"Jurassic period",
"20th century"
],
"title": "Period in Time",
"type": "string"
},
"relativeTime": {
"examples": [
"Later",
"Continuous",
"6 months earlier",
"A long time ago"
],
"title": "Relative Time",
"type": "string"
}
},
"title": "Descriptive Time",
"type": "object"
},
"durationTime": {
"description": "Should be formatted to comply with ISO 8601",
"examples": [
"P2Y12M3D"
],
"pattern": "^(-?)P(?=.)((\\d+)Y)?((\\d+)M)?((\\d+)D)?(T(?=.)((\\d+)H)?((\\d+)M)?(\\d*(\\.\\d+)?S)?)?$",
"title": "Duration of Time",
"type": [
"string",
"null"
]
},
"periodInTime": {
"additionalProperties": false,
"properties": {
"durationTime": {
"title": "Duration of Time",
"type": "string"
},
"endTime": {
"title": "End Time",
"type": "string"
},
"startTime": {
"title": "Start Time",
"type": "string"
}
},
"required": [
"startTime"
],
"title": "Period in Time",
"type": "object"
},
"timecode": {
"description": "SMPTE timecode",
"examples": [
"00:03:43:12"
],
"pattern": "^(?:(?:[0-1][0-9]|[0-2][0-3]):)(?:[0-5][0-9]:){2}(?:[0-2][0-9])$",
"title": "SMPTE Timcode in the format HH:MM:SS:FF. \nAssumes the frame rate is 23.98, 24, 25, 29.97 NDF, or 30",
"type": [
"string",
"null"
]
},
"timestamp": {
"title": "Timestamp",
"type": [
"number",
"null"
]
}
},
"title": "Time",
"type": "object"
},
"unitOfMeasurement": {
"additionalProperties": false,
"properties": {
"dimensions": {
"description": "Encode a set of measurements to describe a 2 or 3 dimensional object (metric, imperial or pixels)",
"properties": {
"depth": {
"description": "The depth or Z axis of the object",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode distance using the metric system of measurement (kilometer, meter, centimetre, millimeter",
"examples": [
"100m",
"6km2m56cm12mm"
],
"pattern": "^-?(\\d+km)?(\\d+m)?(\\d+cm)?(\\d+mm)?$",
"type": "string"
},
{
"description": "Encode distance using the imperial system of measurement (miles, feet, inches)",
"examples": [
"2000ft",
"2mi12ft6in"
],
"pattern": "^-?(\\d+mi)?(\\d+ft)?(\\d+in)?$",
"type": "string"
},
{
"description": "Encode a measurement of the number of pixels, typically in a digital image",
"examples": [
"250px"
],
"pattern": "^(\\d+px)$",
"type": "string"
}
]
},
"height": {
"description": "The height or X axis of the object",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode distance using the metric system of measurement (kilometer, meter, centimetre, millimeter",
"examples": [
"100m",
"6km2m56cm12mm"
],
"pattern": "^-?(\\d+km)?(\\d+m)?(\\d+cm)?(\\d+mm)?$",
"type": "string"
},
{
"description": "Encode distance using the imperial system of measurement (miles, feet, inches)",
"examples": [
"2000ft",
"2mi12ft6in"
],
"pattern": "^-?(\\d+mi)?(\\d+ft)?(\\d+in)?$",
"type": "string"
},
{
"description": "Encode a measurement of the number of pixels, typically in a digital image",
"examples": [
"250px"
],
"pattern": "^(\\d+px)$",
"type": "string"
}
]
},
"width": {
"description": "The width or X axis of the object",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode distance using the metric system of measurement (kilometer, meter, centimetre, millimeter",
"examples": [
"100m",
"6km2m56cm12mm"
],
"pattern": "^-?(\\d+km)?(\\d+m)?(\\d+cm)?(\\d+mm)?$",
"type": "string"
},
{
"description": "Encode distance using the imperial system of measurement (miles, feet, inches)",
"examples": [
"2000ft",
"2mi12ft6in"
],
"pattern": "^-?(\\d+mi)?(\\d+ft)?(\\d+in)?$",
"type": "string"
},
{
"description": "Encode a measurement of the number of pixels, typically in a digital image",
"examples": [
"250px"
],
"pattern": "^(\\d+px)$",
"type": "string"
}
]
}
},
"title": "dimensions",
"type": "object"
},
"linearDistance": {
"description": "Encode a measurement of distance using the imperial or metric system",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode distance using the metric system of measurement (kilometer, meter, centimetre, millimeter",
"examples": [
"100m",
"6km2m56cm12mm"
],
"pattern": "^-?(\\d+km)?(\\d+m)?(\\d+cm)?(\\d+mm)?$",
"type": "string"
},
{
"description": "Encode distance using the imperial system of measurement (miles, feet, inches)",
"examples": [
"2000ft",
"2mi12ft6in"
],
"pattern": "^-?(\\d+mi)?(\\d+ft)?(\\d+in)?$",
"type": "string"
}
],
"title": "Linear Distance"
},
"weight": {
"description": "Encode a measurement of weight using the imperial or metric system",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode weight using the metric system of measurement (kilogram, gram)",
"examples": [
"3kg7g"
],
"pattern": "^(\\d+kg)?(\\d+g)?$",
"type": "string"
},
{
"description": "Encode weight using the imperial system of measurement (pounds, ounces)",
"examples": [
"12lb14oz"
],
"pattern": "^(\\d+lb)?(\\d+oz)?$",
"type": "string"
}
],
"title": "weight"
}
},
"type": "object"
},
"versionNumber": {
"description": "A designation indicating a place in a sequence of versions",
"title": "Version Number",
"type": [
"string",
"number",
"null"
]
}
},
"title": "Utility Definitions",
"type": "object"
},
"core": {
"additionalProperties": false,
"description": "Helper objects used in building the schema",
"properties": {
"customData": {
"additionalProperties": true,
"description": "A user defined set of custom data in the payload of the instance, used where the formal schema lacks required properties",
"title": "Custom Data",
"type": "object"
},
"entityInfo": {
"additionalProperties": false,
"description": "Reserved for future use to describe specific details about the instance of the entity",
"title": "Entity Information",
"type": [
"object",
"null"
]
},
"reference": {
"additionalProperties": false,
"description": "An identifier that references another entity in the graph",
"properties": {
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
}
},
"title": "Reference entity",
"type": [
"object",
"null"
]
},
"rootArray": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Character"
},
{
"$ref": "#/$defs/Participant/properties/Participant"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeAudio"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionLocation"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Slate"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Effect"
},
{
"$ref": "#/$defs/Utility/properties/Location"
},
{
"$ref": "#/$defs/Participant/properties/Role"
},
{
"$ref": "#/$defs/Participant/properties/Person"
},
{
"$ref": "#/$defs/Participant/properties/Department"
},
{
"$ref": "#/$defs/Participant/properties/Organization"
},
{
"$ref": "#/$defs/Participant/properties/Service"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
},
{
"$ref": "#/$defs/Infrastructure/properties/Infrastructure"
},
{
"$ref": "#/$defs/Infrastructure/properties/InfrastructureSC"
},
{
"$ref": "#/$defs/Task/properties/Task"
},
{
"$ref": "#/$defs/Task/properties/TaskSC"
}
]
},
"type": "array"
},
"rootObject": {
"additionalProperties": false,
"properties": {
"Asset": {
"items": {
"$ref": "#/$defs/Asset/properties/Asset"
},
"title": "Asset",
"type": "array"
},
"AssetSC": {
"items": {
"$ref": "#/$defs/Asset/properties/AssetSC"
},
"title": "Asset Structural Characteristics",
"type": "array"
},
"Character": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Character"
},
"title": "Character",
"type": "array"
},
"Context": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Context"
},
"title": "Context",
"type": "array"
},
"CreativeWork": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
},
"title": "Creative Work",
"type": "array"
},
"Department": {
"items": {
"$ref": "#/$defs/Participant/properties/Department"
},
"title": "Department",
"type": "array"
},
"Depiction": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
},
"title": "Context",
"type": "array"
},
"Effect": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Effect"
},
"title": "Effect",
"type": "array"
},
"Location": {
"items": {
"$ref": "#/$defs/Utility/properties/Location"
},
"title": "Location",
"type": "array"
},
"NarrativeAudio": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeAudio"
},
"title": "Narrative Audio",
"type": "array"
},
"NarrativeLocation": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
"title": "Narrative Location",
"type": "array"
},
"NarrativeObject": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject"
},
"title": "Narrative Object",
"type": "array"
},
"NarrativeScene": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene"
},
"title": "Narrative Scene",
"type": "array"
},
"NarrativeStyling": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling"
},
"title": "Narrative Styling",
"type": "array"
},
"NarrativeWardrobe": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe"
},
"title": "Narrative Wardrobe",
"type": "array"
},
"Organization": {
"items": {
"$ref": "#/$defs/Participant/properties/Organization"
},
"title": "Organization",
"type": "array"
},
"Participant": {
"items": {
"$ref": "#/$defs/Participant/properties/Participant"
},
"title": "Participant",
"type": "array"
},
"Person": {
"items": {
"$ref": "#/$defs/Participant/properties/Person"
},
"title": "Person",
"type": "array"
},
"ProductionLocation": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/ProductionLocation"
},
"title": "Production Location",
"type": "array"
},
"ProductionScene": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene"
},
"title": "Production Scene",
"type": "array"
},
"Role": {
"items": {
"$ref": "#/$defs/Participant/properties/Role"
},
"title": "Service",
"type": "array"
},
"Sequence": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
},
"title": "Sequence",
"type": "array"
},
"Service": {
"items": {
"$ref": "#/$defs/Participant/properties/Service"
},
"title": "Service",
"type": "array"
},
"Slate": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Slate"
},
"title": "Slate",
"type": "array"
},
"SpecialAction": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction"
},
"title": "Special Action",
"type": "array"
}
},
"type": "object"
},
"schemaVersion": {
"default": "https://movielabs.com/omc/json/schema/v2.0",
"description": "Describes the version of OMC-JSON schema that was used to create this instance",
"enum": [
"https://movielabs.com/omc/json/schema/v2.0"
],
"title": "Schema Version",
"type": "string"
}
},
"title": "Core",
"type": "object"
}
},
"$id": "https://movielabs.com/omc/json/schema/v2.0",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"oneOf": [
{
"$ref": "#/$defs/core/properties/rootObject"
},
{
"$ref": "#/$defs/core/properties/rootArray"
}
],
"title": "OMC-JSON schema v2.0"
} | Apache-2.0 | en |
GoogleCloudPlatform/opdio | 022143880eb8492e360276f8c3990bfa85c29fb2 | 2024-02-22T01:32:33 | api/schemas/omc-participant.json | 8 | 2024-05-27T06:38:58.005247Z | {
"$comment": "Copyright 2021-2023 Motion Picture Laboratories, Inc.\nSPDX-License-Identifier: APACHE-2.0",
"$defs": {
"Participant": {
"additionalProperties": false,
"properties": {
"Department": {
"additionalProperties": false,
"description": "Part of a larger Organization with a particular set of responsibilities on the production.",
"properties": {
"Location": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Utility/properties/Location"
}
]
},
"contact": {
"$ref": "#/$defs/Utility/properties/contact"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"departmentName": {
"$ref": "#/$defs/Utility/properties/basicName"
},
"description": {
"description": "A brief description of the department",
"title": "Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Department",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the department, primarily for use as a label",
"title": "Department name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"structuralType": {
"const": "department",
"type": "string"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Department",
"type": "object"
},
"Organization": {
"additionalProperties": false,
"description": "A legal entity or groups of people associated with the production.. with a particular purpose relative to the production.",
"properties": {
"Location": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Utility/properties/Location"
}
]
},
"contact": {
"$ref": "#/$defs/Utility/properties/contact"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the organization",
"title": "Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Organization",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the organization, primarily for use as a label",
"title": "Organization name",
"type": [
"string",
"null"
]
},
"organizationName": {
"$ref": "#/$defs/Utility/properties/basicName"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"structuralType": {
"const": "organization",
"type": "string"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Organization",
"type": "object"
},
"Participant": {
"additionalProperties": false,
"description": "The entities (people, organizations, and services) that are responsible for the production of the Creative Work.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"Participant": {
"description": "Any Participants that are members of this Participant group",
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Participant/properties/Participant"
}
]
},
"title": "Participant",
"type": "array"
},
"ParticipantSC": {
"description": "Describes the form of a Participant along with the attributes specific to that Participant\u2019s form.",
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Participant/properties/Person"
},
{
"$ref": "#/$defs/Participant/properties/Department"
},
{
"$ref": "#/$defs/Participant/properties/Organization"
},
{
"$ref": "#/$defs/Participant/properties/Service"
}
],
"title": "Participant Structural Characteristics",
"type": "object"
},
"contact": {
"$ref": "#/$defs/Utility/properties/contact",
"description": "Contact information for the Participant",
"title": "Participant Contact"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the participant",
"title": "Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Participant",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the participant, primarily for use as a label",
"title": "Participant name",
"type": [
"string",
"null"
]
},
"participantFC": {
"additionalProperties": true,
"description": "The use or purpose of a Participant within the production process",
"properties": {
"Role": {
"description": "",
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Participant/properties/Role"
}
]
},
"type": "array"
},
"functionalType": {
"title": "Functional Type",
"type": [
"string",
"null"
]
},
"jobTitle": {
"description": "A formal name for the position a Person holds in relation to the production, usually associated with a specific set of responsibilities.",
"title": "Job Title",
"type": [
"string",
"null"
]
}
},
"title": "Participant Functional Characteristics",
"type": "object"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Participant",
"type": "object"
},
"Person": {
"additionalProperties": false,
"description": "People are the individuals that are associated with the production",
"properties": {
"Location": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Utility/properties/Location"
}
]
},
"contact": {
"$ref": "#/$defs/Utility/properties/contact",
"description": "Contact information for the Person",
"title": "Person Contact"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the person",
"title": "Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Person",
"title": "Entity Type",
"type": "string"
},
"gender": {
"$ref": "#/$defs/Utility/properties/gender"
},
"identifier": {
"description": "An identifier uniquely identifies an entity within a particular scope.",
"items": {
"additionalProperties": false,
"properties": {
"identifierScope": {
"description": "The universe within which an identifier is valid and unique.",
"title": "Identifier Scope",
"type": "string"
},
"identifierValue": {
"description": "A string of characters that uniquely identifies an object within a particular scope.",
"title": "Identifier Value",
"type": "string"
}
},
"required": [
"identifierScope",
"identifierValue"
],
"type": "object"
},
"title": "Identifier",
"type": "array"
},
"jobTitle": {
"description": "A persons job title (as distinct from a specific role)",
"title": "Job Title",
"type": [
"string",
"null"
]
},
"name": {
"description": "A human readable name for the person, convenient for use in UI's etc.",
"title": "Person name",
"type": [
"string",
"null"
]
},
"personName": {
"$ref": "#/$defs/Utility/properties/completeName",
"description": "The canonical name or set of names and titles for the Person",
"title": "Person Name"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"structuralType": {
"const": "person",
"type": "string"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Person",
"type": "object"
},
"Role": {
"additionalProperties": false,
"description": "A set of properties that define the role of a participant within the production",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"title": "Role Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Role",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"examples": [
"Director",
"Producer",
"Composer",
"Art Department"
],
"title": "Role Name",
"type": [
"string",
"null"
]
},
"roleType": {
"description": "The specific role, typically used in authorization systems",
"title": "Role Type",
"type": "string"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Role",
"type": "object"
},
"Service": {
"additionalProperties": false,
"description": "A computer driven agent that can perform tasks given the proper context and structured data.",
"properties": {
"contact": {
"$ref": "#/$defs/Utility/properties/contact"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the service",
"title": "Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Service",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the service, primarily for use as a label",
"title": "Service name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"serviceName": {
"$ref": "#/$defs/Utility/properties/basicName"
},
"structuralType": {
"const": "service",
"type": "string"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Service",
"type": "object"
}
},
"title": "Participant Definitions",
"type": "object"
},
"Utility": {
"additionalProperties": false,
"description": "Common data models and data structures used in multiple places and in multiple ways in a larger system.",
"properties": {
"Location": {
"additionalProperties": false,
"description": "A particular place or position either in either the real world or the narrative world.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": "array"
},
"address": {
"$ref": "#/$defs/Utility/properties/address",
"title": "Address"
},
"coordinates": {
"$ref": "#/$defs/Utility/properties/coordinates",
"title": "Coordinates"
},
"description": {
"description": "A brief description of the location",
"title": "Location Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Location",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier",
"title": "Identifier"
},
"name": {
"description": "A human readable name for the location",
"title": "Location name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Location",
"type": "object"
},
"address": {
"additionalProperties": false,
"description": "A postal address or identifiable location of a place or building",
"properties": {
"country": {
"$ref": "#/$defs/Utility/properties/country",
"title": "Country"
},
"locality": {
"description": "The locality in which the street address is, and which is in the region.",
"examples": [
"Mountain View"
],
"title": "Address locality",
"type": [
"string",
"null"
]
},
"postalCode": {
"description": "A zip or postal code",
"examples": [
"94534"
],
"title": "Zip or Postal Code",
"type": [
"string",
"null"
]
},
"region": {
"description": "The region in which the locality is, and which is in the country",
"examples": [
"California"
],
"title": "Address region",
"type": [
"string",
"null"
]
},
"street": {
"description": "The street address",
"examples": [
"1600 Amphitheater Parkway"
],
"title": "Street Address",
"type": [
"string",
"null"
]
}
},
"title": "Address",
"type": [
"object",
"null"
]
},
"basicName": {
"additionalProperties": false,
"description": "A description of things name and an alternative name",
"properties": {
"altName": {
"description": "An alternate, often shortened name for the entity",
"title": "Alternate Name",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full an complete name of the entity",
"title": "Full Name",
"type": [
"string",
"null"
]
}
},
"title": "Basic Name",
"type": [
"object",
"null"
]
},
"completeName": {
"additionalProperties": false,
"description": "A detailed description of a person, or others, name and variants of their name.",
"properties": {
"alias": {
"description": "An alias being used by a person often used to disguise someones real identity, sometimes used when booking hotel rooms or restaurants ",
"title": "Alias",
"type": [
"string",
"null"
]
},
"altName": {
"title": "Alternate Name",
"type": [
"string",
"null"
]
},
"birthName": {
"description": "A persons name at birth, also referred to as maiden name",
"title": "Birth Name",
"type": [
"string",
"null"
]
},
"contractualName": {
"title": "Contractual Name",
"type": [
"string",
"null"
]
},
"displayName": {
"title": "Display Name",
"type": [
"string",
"null"
]
},
"familyName": {
"description": "A persons family name, also referred to as surname",
"title": "Family Name",
"type": [
"string",
"null"
]
},
"firstGivenName": {
"description": "A person's first name, also referred to as given name",
"title": "First Given Name",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "A complete name, typically a conjunction of familyName, firstGivenName and possibly other fields.",
"title": "Full Name",
"type": [
"string",
"null"
]
},
"moniker": {
"title": "Moniker",
"type": [
"string",
"null"
]
},
"nickname": {
"title": "Nickname",
"type": [
"string",
"null"
]
},
"prefix": {
"description": "A prefix that can indicate a persons gender or title",
"examples": [
"Mrs",
"Mr",
"Dr",
"General"
],
"title": "Prefix",
"type": [
"string",
"null"
]
},
"primaryName": {
"description": "A persons primary name, one they typically use, also often a combination of first, second and family name",
"title": "Primary Name",
"type": [
"string",
"null"
]
},
"pseudonym": {
"title": "Pseudonym",
"type": [
"string",
"null"
]
},
"scriptName": {
"title": "Script Name",
"type": [
"string",
"null"
]
},
"secondGivenName": {
"description": "A persons second given name, also referred to as middle name",
"title": "Second Given Name",
"type": [
"string",
"null"
]
},
"sortName": {
"title": "Sort Name",
"type": [
"string",
"null"
]
},
"suffix": {
"description": "A suffix, often used to indicate a title or classification",
"examples": [
"MBE",
"MD",
"RN",
"II",
"IV"
],
"title": "Suffix",
"type": [
"string",
"null"
]
},
"translatedName": {
"title": "Translated Name",
"type": [
"string",
"null"
]
}
},
"title": "Complete Name",
"type": "object"
},
"contact": {
"additionalProperties": false,
"properties": {
"email": {
"$ref": "#/$defs/Utility/properties/email",
"title": "Email"
},
"telephone": {
"$ref": "#/$defs/Utility/properties/telephone",
"title": "Telephone"
}
},
"title": "Contact",
"type": "object"
},
"coordinates": {
"additionalProperties": false,
"description": "A global positioning coordinate in compliance with WGS 84",
"properties": {
"latitude": {
"maximum": 90,
"minimum": -90,
"title": "latitude",
"type": "number"
},
"longitude": {
"maximum": 180,
"minimum": -180,
"title": "longitude",
"type": "number"
}
},
"title": "Coordinates",
"type": [
"object",
"null"
]
},
"country": {
"description": "The country, as an ISO 3166-1 alpha-2 country code",
"examples": [
"US"
],
"maxLength": 2,
"minLength": 2,
"title": "Country",
"type": [
"string",
"null"
]
},
"email": {
"additionalProperties": false,
"properties": {
"business": {
"title": "Business",
"type": [
"string",
"null"
]
},
"personal": {
"title": "Personal",
"type": [
"string",
"null"
]
}
},
"title": "Email",
"type": "object"
},
"gender": {
"additionalProperties": false,
"description": "A person, or others, expressed or prefered gender and pronoun",
"properties": {
"gender": {
"description": "The gender by which an individual identifies",
"enum": [
"male",
"female",
"other",
"unknown",
null
],
"title": "Identifies as gender",
"type": [
"string",
"null"
]
},
"genderPronoun": {
"description": "An individuals pronoun of choice",
"enum": [
"he/him",
"she/her",
"ze/hir",
"they/their",
null
],
"title": "Preferred pronoun",
"type": [
"string",
"null"
]
}
},
"title": "Gender",
"type": [
"object",
"null"
]
},
"identifier": {
"description": "An identifier uniquely identifies an entity within a particular scope.",
"items": {
"additionalProperties": false,
"properties": {
"combinedForm": {
"description": "A combination of the Identifier Scope and Value that is useful for utilizing the identifier in a system, for example a URN (URN:ID:IdentifierScope:IdentifierValue).",
"title": "Identifier Combined Form",
"type": "string"
},
"identifierScope": {
"description": "The universe within which an identifier is valid and unique.",
"title": "Identifier Scope",
"type": "string"
},
"identifierValue": {
"description": "A string of characters that uniquely identifies an object within a particular scope.",
"title": "Identifier Value",
"type": "string"
},
"url": {
"description": "A URL or IRI that can be used for resolving the Identifier Value within the Identifier Scope.",
"title": "URL",
"type": "string"
}
},
"required": [
"identifierScope",
"identifierValue"
],
"type": "object"
},
"minItems": 1,
"title": "Identifier",
"type": "array"
},
"language": {
"description": "An IETF BCP 47 language code",
"title": "Language",
"type": [
"string",
"null"
]
},
"note": {
"additionalProperties": false,
"properties": {
"text": {
"description": "The text of the note or annotation",
"title": "Text",
"type": "string"
},
"title": {
"description": "A title for the note or annotation",
"title": "Title",
"type": "string"
}
},
"title": "Note",
"type": [
"object",
"null"
]
},
"telephone": {
"additionalProperties": false,
"properties": {
"business": {
"title": "Business",
"type": [
"string",
"null"
]
},
"personal": {
"title": "Personal",
"type": [
"string",
"null"
]
}
},
"title": "Telephone",
"type": "object"
},
"time": {
"additionalProperties": false,
"properties": {
"date": {
"description": "Should be formatted to comply with ISO 8601",
"examples": [
"2020-11-21"
],
"pattern": "\\d{4}-[01]\\d-[0-3]\\d",
"title": "Date",
"type": [
"string",
"null"
]
},
"dateTime": {
"description": "Should be formatted to comply with ISO 8601",
"examples": [
"2023-08-24T20:51:15Z\n2023-08-24T20:51:15.56Z\n2023-08-24T20:51:15+08:00\n2023-08-24T20:51:15.23-04:00"
],
"pattern": "^(?:19|20)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:|\\.\\d\\d)(?:Z|-0[1-9]|-1\\d|-2[0-3]|-00:?(?:0[1-9]|[1-5]\\d)|\\+[01]\\d|\\+2[0-3])(?:|:?[0-5]\\d)$",
"title": "Date & Time",
"type": [
"string",
"null"
]
},
"descriptiveTime": {
"additionalProperties": false,
"properties": {
"eventInTime": {
"description": "Describes a specific event that occurred",
"examples": [
"Hindenburg disaster",
"World Trade Center attack",
"Queen Elizabeth coronation"
],
"title": "Event in Time",
"type": "string"
},
"periodInDay": {
"examples": [
"Morning",
"Noon",
"Midnight",
"Afternoon",
"Night"
],
"title": "Period in Day",
"type": "string"
},
"periodInTime": {
"examples": [
"Ming dynasty",
"World War II",
"Jurassic period",
"20th century"
],
"title": "Period in Time",
"type": "string"
},
"relativeTime": {
"examples": [
"Later",
"Continuous",
"6 months earlier",
"A long time ago"
],
"title": "Relative Time",
"type": "string"
}
},
"title": "Descriptive Time",
"type": "object"
},
"durationTime": {
"description": "Should be formatted to comply with ISO 8601",
"examples": [
"P2Y12M3D"
],
"pattern": "^(-?)P(?=.)((\\d+)Y)?((\\d+)M)?((\\d+)D)?(T(?=.)((\\d+)H)?((\\d+)M)?(\\d*(\\.\\d+)?S)?)?$",
"title": "Duration of Time",
"type": [
"string",
"null"
]
},
"periodInTime": {
"additionalProperties": false,
"properties": {
"durationTime": {
"title": "Duration of Time",
"type": "string"
},
"endTime": {
"title": "End Time",
"type": "string"
},
"startTime": {
"title": "Start Time",
"type": "string"
}
},
"required": [
"startTime"
],
"title": "Period in Time",
"type": "object"
},
"timecode": {
"description": "SMPTE timecode",
"examples": [
"00:03:43:12"
],
"pattern": "^(?:(?:[0-1][0-9]|[0-2][0-3]):)(?:[0-5][0-9]:){2}(?:[0-2][0-9])$",
"title": "SMPTE Timcode in the format HH:MM:SS:FF. \nAssumes the frame rate is 23.98, 24, 25, 29.97 NDF, or 30",
"type": [
"string",
"null"
]
},
"timestamp": {
"title": "Timestamp",
"type": [
"number",
"null"
]
}
},
"title": "Time",
"type": "object"
},
"unitOfMeasurement": {
"additionalProperties": false,
"properties": {
"dimensions": {
"description": "Encode a set of measurements to describe a 2 or 3 dimensional object (metric, imperial or pixels)",
"properties": {
"depth": {
"description": "The depth or Z axis of the object",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode distance using the metric system of measurement (kilometer, meter, centimetre, millimeter",
"examples": [
"100m",
"6km2m56cm12mm"
],
"pattern": "^-?(\\d+km)?(\\d+m)?(\\d+cm)?(\\d+mm)?$",
"type": "string"
},
{
"description": "Encode distance using the imperial system of measurement (miles, feet, inches)",
"examples": [
"2000ft",
"2mi12ft6in"
],
"pattern": "^-?(\\d+mi)?(\\d+ft)?(\\d+in)?$",
"type": "string"
},
{
"description": "Encode a measurement of the number of pixels, typically in a digital image",
"examples": [
"250px"
],
"pattern": "^(\\d+px)$",
"type": "string"
}
]
},
"height": {
"description": "The height or X axis of the object",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode distance using the metric system of measurement (kilometer, meter, centimetre, millimeter",
"examples": [
"100m",
"6km2m56cm12mm"
],
"pattern": "^-?(\\d+km)?(\\d+m)?(\\d+cm)?(\\d+mm)?$",
"type": "string"
},
{
"description": "Encode distance using the imperial system of measurement (miles, feet, inches)",
"examples": [
"2000ft",
"2mi12ft6in"
],
"pattern": "^-?(\\d+mi)?(\\d+ft)?(\\d+in)?$",
"type": "string"
},
{
"description": "Encode a measurement of the number of pixels, typically in a digital image",
"examples": [
"250px"
],
"pattern": "^(\\d+px)$",
"type": "string"
}
]
},
"width": {
"description": "The width or X axis of the object",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode distance using the metric system of measurement (kilometer, meter, centimetre, millimeter",
"examples": [
"100m",
"6km2m56cm12mm"
],
"pattern": "^-?(\\d+km)?(\\d+m)?(\\d+cm)?(\\d+mm)?$",
"type": "string"
},
{
"description": "Encode distance using the imperial system of measurement (miles, feet, inches)",
"examples": [
"2000ft",
"2mi12ft6in"
],
"pattern": "^-?(\\d+mi)?(\\d+ft)?(\\d+in)?$",
"type": "string"
},
{
"description": "Encode a measurement of the number of pixels, typically in a digital image",
"examples": [
"250px"
],
"pattern": "^(\\d+px)$",
"type": "string"
}
]
}
},
"title": "dimensions",
"type": "object"
},
"linearDistance": {
"description": "Encode a measurement of distance using the imperial or metric system",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode distance using the metric system of measurement (kilometer, meter, centimetre, millimeter",
"examples": [
"100m",
"6km2m56cm12mm"
],
"pattern": "^-?(\\d+km)?(\\d+m)?(\\d+cm)?(\\d+mm)?$",
"type": "string"
},
{
"description": "Encode distance using the imperial system of measurement (miles, feet, inches)",
"examples": [
"2000ft",
"2mi12ft6in"
],
"pattern": "^-?(\\d+mi)?(\\d+ft)?(\\d+in)?$",
"type": "string"
}
],
"title": "Linear Distance"
},
"weight": {
"description": "Encode a measurement of weight using the imperial or metric system",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode weight using the metric system of measurement (kilogram, gram)",
"examples": [
"3kg7g"
],
"pattern": "^(\\d+kg)?(\\d+g)?$",
"type": "string"
},
{
"description": "Encode weight using the imperial system of measurement (pounds, ounces)",
"examples": [
"12lb14oz"
],
"pattern": "^(\\d+lb)?(\\d+oz)?$",
"type": "string"
}
],
"title": "weight"
}
},
"type": "object"
},
"versionNumber": {
"description": "A designation indicating a place in a sequence of versions",
"title": "Version Number",
"type": [
"string",
"number",
"null"
]
}
},
"title": "Utility Definitions",
"type": "object"
},
"core": {
"additionalProperties": false,
"description": "Helper objects used in building the schema",
"properties": {
"customData": {
"additionalProperties": true,
"description": "A user defined set of custom data in the payload of the instance, used where the formal schema lacks required properties",
"title": "Custom Data",
"type": "object"
},
"entityInfo": {
"additionalProperties": false,
"description": "Reserved for future use to describe specific details about the instance of the entity",
"title": "Entity Information",
"type": [
"object",
"null"
]
},
"reference": {
"additionalProperties": false,
"description": "An identifier that references another entity in the graph",
"properties": {
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
}
},
"title": "Reference entity",
"type": [
"object",
"null"
]
},
"rootArray": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Character"
},
{
"$ref": "#/$defs/Participant/properties/Participant"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeAudio"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionLocation"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Slate"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Effect"
},
{
"$ref": "#/$defs/Utility/properties/Location"
},
{
"$ref": "#/$defs/Participant/properties/Role"
},
{
"$ref": "#/$defs/Participant/properties/Person"
},
{
"$ref": "#/$defs/Participant/properties/Department"
},
{
"$ref": "#/$defs/Participant/properties/Organization"
},
{
"$ref": "#/$defs/Participant/properties/Service"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
},
{
"$ref": "#/$defs/Infrastructure/properties/Infrastructure"
},
{
"$ref": "#/$defs/Infrastructure/properties/InfrastructureSC"
},
{
"$ref": "#/$defs/Task/properties/Task"
},
{
"$ref": "#/$defs/Task/properties/TaskSC"
}
]
},
"type": "array"
},
"rootObject": {
"additionalProperties": false,
"properties": {
"Asset": {
"items": {
"$ref": "#/$defs/Asset/properties/Asset"
},
"title": "Asset",
"type": "array"
},
"AssetSC": {
"items": {
"$ref": "#/$defs/Asset/properties/AssetSC"
},
"title": "Asset Structural Characteristics",
"type": "array"
},
"Character": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Character"
},
"title": "Character",
"type": "array"
},
"Context": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Context"
},
"title": "Context",
"type": "array"
},
"CreativeWork": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
},
"title": "Creative Work",
"type": "array"
},
"Department": {
"items": {
"$ref": "#/$defs/Participant/properties/Department"
},
"title": "Department",
"type": "array"
},
"Depiction": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
},
"title": "Context",
"type": "array"
},
"Effect": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Effect"
},
"title": "Effect",
"type": "array"
},
"Location": {
"items": {
"$ref": "#/$defs/Utility/properties/Location"
},
"title": "Location",
"type": "array"
},
"NarrativeAudio": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeAudio"
},
"title": "Narrative Audio",
"type": "array"
},
"NarrativeLocation": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
"title": "Narrative Location",
"type": "array"
},
"NarrativeObject": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject"
},
"title": "Narrative Object",
"type": "array"
},
"NarrativeScene": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene"
},
"title": "Narrative Scene",
"type": "array"
},
"NarrativeStyling": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling"
},
"title": "Narrative Styling",
"type": "array"
},
"NarrativeWardrobe": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe"
},
"title": "Narrative Wardrobe",
"type": "array"
},
"Organization": {
"items": {
"$ref": "#/$defs/Participant/properties/Organization"
},
"title": "Organization",
"type": "array"
},
"Participant": {
"items": {
"$ref": "#/$defs/Participant/properties/Participant"
},
"title": "Participant",
"type": "array"
},
"Person": {
"items": {
"$ref": "#/$defs/Participant/properties/Person"
},
"title": "Person",
"type": "array"
},
"ProductionLocation": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/ProductionLocation"
},
"title": "Production Location",
"type": "array"
},
"ProductionScene": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene"
},
"title": "Production Scene",
"type": "array"
},
"Role": {
"items": {
"$ref": "#/$defs/Participant/properties/Role"
},
"title": "Service",
"type": "array"
},
"Sequence": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
},
"title": "Sequence",
"type": "array"
},
"Service": {
"items": {
"$ref": "#/$defs/Participant/properties/Service"
},
"title": "Service",
"type": "array"
},
"Slate": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Slate"
},
"title": "Slate",
"type": "array"
},
"SpecialAction": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction"
},
"title": "Special Action",
"type": "array"
}
},
"type": "object"
},
"schemaVersion": {
"default": "https://movielabs.com/omc/json/schema/v2.0",
"description": "Describes the version of OMC-JSON schema that was used to create this instance",
"enum": [
"https://movielabs.com/omc/json/schema/v2.0"
],
"title": "Schema Version",
"type": "string"
}
},
"title": "Core",
"type": "object"
}
},
"$id": "https://movielabs.com/omc/json/schema/v2.0",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"oneOf": [
{
"$ref": "#/$defs/core/properties/rootObject"
},
{
"$ref": "#/$defs/core/properties/rootArray"
}
],
"title": "OMC-JSON schema v2.0"
} | Apache-2.0 | en |
GoogleCloudPlatform/opdio | 242fd7ba8581e850454fec35bde118a6e831f184 | 2024-02-22T01:07:32 | api/schemas/omc-context.json | 8 | 2024-05-27T06:38:58.005247Z | {
"$comment": "Copyright 2021-2023 Motion Picture Laboratories, Inc.\nSPDX-License-Identifier: APACHE-2.0",
"$defs": {
"MediaCreationContext": {
"additionalProperties": false,
"properties": {
"Character": {
"additionalProperties": false,
"description": "A sentient entity (usually a person but not always) in the script whose specific identity is consequential to the narrative. A Character is generally identified by a specific name.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"characterName": {
"$ref": "#/$defs/Utility/properties/completeName",
"title": "Character Name"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the character",
"title": "Character Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Character",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "The primary name used for the character",
"title": "Asset name",
"type": [
"string",
"null"
]
},
"profile": {
"additionalProperties": false,
"properties": {
"background": {
"additionalProperties": true,
"title": "background",
"type": "object"
},
"gender": {
"$ref": "#/$defs/Utility/properties/gender"
},
"physicalCharacteristics": {
"additionalProperties": true,
"description": "Allows for the the description of certain physical characteristics on a character, things that might be useful to an art department, wardrobe or casting for example.",
"properties": {
"eyeColor": {
"description": "The color of the characters eyes",
"title": "Eye Color",
"type": "string"
},
"hairColor": {
"description": "The hair color of the character",
"examples": [
"Brown",
"Pink",
"Blonde",
""
],
"title": "Hair Color",
"type": "string"
},
"hairLength": {
"description": "The length of hair of the character",
"title": "Hair Length",
"type": "string"
},
"height": {
"$ref": "#/$defs/Utility/properties/unitOfMeasurement/properties/linearDistance",
"title": "height"
},
"species": {
"description": "A species to which this character belongs",
"examples": [
"Human",
"Borg",
"Goblin",
"Frog"
],
"title": "Species",
"type": "string"
},
"weight": {
"$ref": "#/$defs/Utility/properties/unitOfMeasurement/properties/weight",
"title": "weight"
}
},
"title": "Physical Characteristics",
"type": "object"
}
},
"title": "Profile",
"type": "object"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Character",
"type": "object"
},
"Context": {
"additionalProperties": true,
"description": "Informs scope within the construction process of a Creative Work.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context",
"type": "object"
}
]
},
"type": [
"array",
"null"
]
},
"For": {
"description": "The entities for which this Context applies to",
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Character"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
},
{
"$ref": "#/$defs/Participant/properties/Participant"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeAudio"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Effect"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionLocation"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Slate"
}
]
},
"title": "Context For",
"type": [
"array",
"null"
]
},
"contextType": {
"description": "A classifiaction of the type of context represented",
"examples": [
"narrative",
"production"
],
"title": "Context Type",
"type": [
"string",
"null"
]
},
"contributesTo": {
"properties": {
"CreativeWork": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"contributor": {
"properties": {
"Participant": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Participant/properties/Participant",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A brief description of the context",
"title": "Description",
"type": "object"
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Context",
"title": "Entity Type",
"type": "string"
},
"features": {
"properties": {
"Character": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Character"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Effect": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Effect"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeAudio": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeAudio"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeLocation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeObject": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeStyling": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeWardrobe": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"SpecialAction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"featuresIn": {
"properties": {
"NarrativeScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"for": {
"properties": {
"Asset": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Asset/properties/Asset"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"CreativeWork": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"ProductionScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Sequence": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Slate": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Slate"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"has": {
"properties": {
"Asset": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Asset/properties/Asset"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Infrastructure": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Infrastructure/properties/Infrastructure",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeLocation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Participant": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Participant/properties/Participant",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"ProductionScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Sequence": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Slate": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Slate",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"SpecialAction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the Context",
"title": "Context name",
"type": [
"string",
"null"
]
},
"neededBy": {
"properties": {
"Character": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Character",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"needs": {
"properties": {
"Effect": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Effect",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeAudio": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeAudio",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeObject": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeStyling": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeWardrobe": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"SpecialAction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"releated": {
"properties": {
"ProductionScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"representedBy": {
"properties": {
"ProductionScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"represents": {
"properties": {
"NarrativeScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"usedIn": {
"properties": {
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"ProductionLocation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionLocation",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"ProductionScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"uses": {
"properties": {
"Asset": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Asset/properties/Asset",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Infrastructure": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Infrastructure/properties/Infrastructure",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"ProductionLocation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionLocation",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Context",
"type": "object"
},
"CreativeWork": {
"additionalProperties": false,
"description": "A uniquely identified production.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"approximateLength": {
"$ref": "#/$defs/Utility/properties/time/properties/periodInTime/properties/durationTime",
"title": "Approximate Length"
},
"countryOfOrigin": {
"items": {
"$ref": "#/$defs/Utility/properties/country"
},
"title": "Country Of Origin",
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A brief description of the creative work",
"title": "Creative Work Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "CreativeWork",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "The primary name used for the creative work",
"title": "Creative Work name",
"type": [
"string",
"null"
]
},
"originalLanguage": {
"items": {
"$ref": "#/$defs/Utility/properties/language"
},
"title": "Original Languages",
"type": [
"array",
"null"
]
},
"title": {
"additionalProperties": true,
"properties": {
"internalTitle": {
"description": "The internal title of the work",
"title": "Creative Work Internal Title",
"type": [
"string",
"null"
]
},
"officialTitle": {
"description": "The official title of the work",
"title": "Creative Work Official Title",
"type": [
"string",
"null"
]
},
"workingTitle": {
"description": "The working title of the work",
"title": "Creative Work Working Title",
"type": [
"string",
"null"
]
}
},
"title": "Creative Work Title",
"type": "object"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Creative Work",
"type": "object"
},
"Depiction": {
"additionalProperties": false,
"description": "The representation of something from a narrative entity by a production entity in the Creative Work, specified or implied by the Script.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depictor": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
},
{
"$ref": "#/$defs/Participant/properties/Participant"
}
],
"type": "object"
},
"Depicts": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Character"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe"
}
],
"type": "object"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"depictionType": {
"description": "A categorization of the type of depiction",
"enum": [
"depiction",
"portrayal"
],
"title": "Object type",
"type": "string"
},
"description": {
"description": "A brief description of the depiction or portrayal",
"title": "Depiction Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Depiction",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the styling",
"title": "Depiction Styling Name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Depiction",
"type": "object"
},
"Effect": {
"additionalProperties": false,
"description": "An on screen visual effect considered essential to the narrative.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A brief description of the narrative effect",
"title": "Narrative Object Description",
"type": [
"string",
"null"
]
},
"effectType": {
"description": "A categorization of the type of effect.",
"enum": [
"effect",
"specialEffect",
"visualEffect"
],
"title": "Object type",
"type": "string"
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Effect",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the effect",
"title": "Narrative Effect Name",
"type": [
"string",
"null"
]
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Effect",
"type": "object"
},
"NarrativeAudio": {
"additionalProperties": false,
"description": "A named piece of audio significant to the narrative.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A brief description of the narrative audio",
"title": "Narrative Audio Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "NarrativeAudio",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the audio clip",
"title": "Narrative Object Name",
"type": [
"string",
"null"
]
},
"narrativeType": {
"description": "A categorization of the type of audio.",
"enum": [
"audio",
"soundEffect",
"music"
],
"title": "Object type",
"type": "string"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Narrative Audio",
"type": "object"
},
"NarrativeLocation": {
"additionalProperties": false,
"description": "A location specified or implied by the narrative.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"Location": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Utility/properties/Location"
}
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the narrative location",
"title": "Narrative Location Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "NarrativeLocation",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the location",
"title": "Narrative Location Name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Narrative Location",
"type": "object"
},
"NarrativeObject": {
"additionalProperties": false,
"description": "A named object related to or interacting with characters that is implied or understood to be necessary for the narrative. Includes items like props, wardrobe, set dressing and vehicles.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A brief description of the narrative object",
"title": "Narrative Object Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "NarrativeObject",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the object",
"title": "Narrative Object Name",
"type": [
"string",
"null"
]
},
"narrativeType": {
"description": "A departmental categorization for the object.",
"enum": [
"narrativeObject",
"narrativeProp",
"narrativeGreenery",
"narrativeVehicle",
"narrativeSetDressing"
],
"title": "Object type",
"type": "string"
},
"quantity": {
"title": "Quantity",
"type": [
"string",
"number"
]
},
"size": {
"title": "Size",
"type": [
"string",
"null"
]
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Narrative Object",
"type": "object"
},
"NarrativeScene": {
"additionalProperties": false,
"description": "Taken from the narrative itself and traditionally defined by creative intent and typically a unity of time, place, action, or theme.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the narrative scene",
"title": "Narrative Scene Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "NarrativeScene",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the scene",
"title": "Scene Name",
"type": "string"
},
"sceneName": {
"additionalProperties": true,
"description": "A human readable name for the scene",
"properties": {
"altName": {
"description": "An alternate, often shorter, name used in applications to identify the scenes",
"title": "Scene alternate name",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "A full descriptive name for the scene",
"title": "Scene full name",
"type": [
"string",
"null"
]
}
},
"title": "Narrative Scene Name",
"type": "object"
},
"sceneNumber": {
"description": "A number used in the script to refer to the scene",
"title": "Scene Number",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion"
},
"slugline": {
"items": {
"additionalProperties": false,
"description": "An arbitrary note or comment pertaining to the entity",
"properties": {
"text": {
"description": "The text of the note or annotation",
"title": "Text",
"type": [
"string",
"null"
]
},
"title": {
"description": "A title for the note or annotation",
"title": "Title",
"type": [
"string",
"null"
]
}
},
"title": "Slugline",
"type": "object"
},
"title": "Slugline",
"type": "array"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Narrative Scene",
"type": "object"
},
"NarrativeStyling": {
"additionalProperties": false,
"description": "Styling required to prepare an actor for their role",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the narrative styling",
"title": "Narrative Styling Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "NarrativeStyling",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the styling",
"title": "Narrative Styling Name",
"type": [
"string",
"null"
]
},
"narrativeType": {
"description": "A categorization of the type styling.",
"enum": [
"narrativeStyling",
"narrativeHair",
"narrativeMakeup",
"narrativeProsthetics"
],
"title": "Object type",
"type": "string"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Narrative Styling",
"type": "object"
},
"NarrativeWardrobe": {
"additionalProperties": false,
"description": "The clothing for a Character in the narrative.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the narrative wardrobe",
"title": "Narrative Wardrobe Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "NarrativeWardrobe",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the styling",
"title": "Narrative Styling Name",
"type": [
"string",
"null"
]
},
"narrativeType": {
"description": "A categorization of the type wardrobe",
"enum": [
"narrativeWardrobe"
],
"title": "Object type",
"type": "string"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Narrative Wardrobe",
"type": "object"
},
"ProductionLocation": {
"additionalProperties": false,
"description": "A real place that is used to depict the Narrative Location or used for creating the production.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Location": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Utility/properties/Location"
}
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A brief description of the production location",
"title": "Production Location Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "ProductionLocation",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"locationType": {
"default": "production",
"description": "Describes whether this is production location or more specifically a shooting location",
"enum": [
"production",
"shooting"
],
"type": "string"
},
"name": {
"description": "A human readable name for the location",
"title": "Production Location Name",
"type": [
"string",
"null"
]
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Production Location",
"type": "object"
},
"ProductionScene": {
"additionalProperties": false,
"description": "Defined either by explicit divisions in the structure of the Script, e.g., by a Slugline, or by additional capture for use in the Creative Work that is not tied to any particular Scene in the Script.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A human readable description of the production scene",
"title": "Asset description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "ProductionScene",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the production scene",
"title": "Asset name",
"type": [
"string",
"null"
]
},
"sceneDescriptor": {
"description": "An alphanumeric reference to a Production Scene",
"title": "Scene Descriptor",
"type": [
"string",
"null"
]
},
"sceneHeader": {
"description": "Used when referring to the Production Scene. It is generally synonymous with Slugline and is used to divide a Script into scenes.",
"title": "Scene Header",
"type": [
"string",
"null"
]
},
"sceneName": {
"$ref": "#/$defs/Utility/properties/basicName",
"title": "Scene Name"
},
"sceneNumber": {
"description": "A number tied to a Slugline when a Script is locked",
"title": "Scene Number",
"type": [
"null",
"string"
]
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Production Scene",
"type": "object"
},
"Sequence": {
"additionalProperties": false,
"description": "A sequence of shots linked to creative intent.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"SCD": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
],
"title": "Sequence Chronology Descriptor"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the sequence",
"title": "Sequence description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Sequence",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the editorial sequence",
"title": "Sequence Name",
"type": [
"string",
"null"
]
},
"provenance": {
"$ref": "#/$defs/Utility/properties/provenance",
"title": "Provenance"
},
"sequenceType": {
"enum": [
"vfx",
"editorial",
"image",
"animation",
"color"
],
"title": "Sequence Type",
"type": "string"
},
"version": {
"additionalProperties": false,
"description": "A particular form, variant, or representation of an Asset that differs in some way from its source Asset.",
"properties": {
"Alternative": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
}
]
},
"type": "array"
},
"Revision": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
}
]
},
"type": "array"
},
"RevisionOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
}
]
},
"Variant": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
}
]
},
"type": "array"
},
"VariantOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
}
]
},
"annotation": {
"description": "A collection of notes specific to this version",
"items": {
"$ref": "#/$defs/Utility/properties/note"
},
"type": "array"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A human readable description of the version",
"title": "Asset description",
"type": [
"string",
"null"
]
},
"name": {
"title": "A name for this specific version of the Asset",
"type": "string"
},
"versionNumber": {
"$ref": "#/$defs/Utility/properties/versionNumber"
}
},
"title": "Sequence Version Information",
"type": "object"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Sequence",
"type": "object"
},
"Slate": {
"additionalProperties": false,
"description": "Used to capture key identifying information about what is being recorded on any given setup and take.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"CreativeWork": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
}
]
},
"Director": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Participant/properties/Participant"
}
]
},
"title": "Director",
"type": [
"array",
"null"
]
},
"cameraLabel": {
"description": "Label for the Camera responsible for the Capture, usually related to the role and responsibility of the group operating it and usually a single upper-case letter starting with A.",
"title": "Camera Label",
"type": [
"string",
"null"
]
},
"cameraRoll": {
"description": "Identifier for a group of events captured together on the same camera on the same media.",
"title": "Camera Roll",
"type": [
"string",
"null"
]
},
"cameraUnit": {
"description": "A group of Participants responsible for shooting some element of a Scene, e.g., a Main Unit or Second Unit.",
"title": "Camera Unit",
"type": [
"string",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the slate",
"title": "Slate description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Slate",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the Slate",
"title": "Slate Name",
"type": [
"string",
"null"
]
},
"recordingFPS": {
"description": "Frames per second recorded by the camera.",
"title": "Recording FPS",
"type": [
"number",
"null"
]
},
"shootDate": {
"$ref": "#/$defs/Utility/properties/time/properties/date",
"description": "The date of capture or creation",
"title": "Shoot Date"
},
"shootDay": {
"description": "The number of the day on the shooting schedule.",
"title": "Shoot Day",
"type": [
"number",
"string",
"null"
]
},
"slateUID": {
"description": "Slate Unique Identifier",
"title": "Slate UID",
"type": "string"
},
"soundRoll": {
"description": "Identifier for a group of audio events captured together on the same recording device and same media.",
"title": "Sound Roll",
"type": [
"string",
"null"
]
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Slate",
"type": "object"
},
"SpecialAction": {
"additionalProperties": false,
"description": "An action or set of actions that are performed and require additional choreography or supervision.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"actionType": {
"description": "A categorization of the type action.",
"enum": [
"action",
"stunt",
"choreography",
"fight",
"motionCapture",
"marine",
"aerial"
],
"title": "Object type",
"type": "string"
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A brief description of the narrative action",
"title": "Narrative Object Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "NarrativeAction",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the action",
"title": "Narrative Action Name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Special Action",
"type": "object"
}
},
"title": "Media Creation Context Definitions",
"type": "object"
},
"core": {
"additionalProperties": false,
"description": "Helper objects used in building the schema",
"properties": {
"customData": {
"additionalProperties": true,
"description": "A user defined set of custom data in the payload of the instance, used where the formal schema lacks required properties",
"title": "Custom Data",
"type": "object"
},
"entityInfo": {
"additionalProperties": false,
"description": "Reserved for future use to describe specific details about the instance of the entity",
"title": "Entity Information",
"type": [
"object",
"null"
]
},
"reference": {
"additionalProperties": false,
"description": "An identifier that references another entity in the graph",
"properties": {
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
}
},
"title": "Reference entity",
"type": [
"object",
"null"
]
},
"rootArray": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Character"
},
{
"$ref": "#/$defs/Participant/properties/Participant"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeAudio"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionLocation"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Slate"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Effect"
},
{
"$ref": "#/$defs/Utility/properties/Location"
},
{
"$ref": "#/$defs/Participant/properties/Role"
},
{
"$ref": "#/$defs/Participant/properties/Person"
},
{
"$ref": "#/$defs/Participant/properties/Department"
},
{
"$ref": "#/$defs/Participant/properties/Organization"
},
{
"$ref": "#/$defs/Participant/properties/Service"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
},
{
"$ref": "#/$defs/Infrastructure/properties/Infrastructure"
},
{
"$ref": "#/$defs/Infrastructure/properties/InfrastructureSC"
},
{
"$ref": "#/$defs/Task/properties/Task"
},
{
"$ref": "#/$defs/Task/properties/TaskSC"
}
]
},
"type": "array"
},
"rootObject": {
"additionalProperties": false,
"properties": {
"Asset": {
"items": {
"$ref": "#/$defs/Asset/properties/Asset"
},
"title": "Asset",
"type": "array"
},
"AssetSC": {
"items": {
"$ref": "#/$defs/Asset/properties/AssetSC"
},
"title": "Asset Structural Characteristics",
"type": "array"
},
"Character": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Character"
},
"title": "Character",
"type": "array"
},
"Context": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Context"
},
"title": "Context",
"type": "array"
},
"CreativeWork": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
},
"title": "Creative Work",
"type": "array"
},
"Department": {
"items": {
"$ref": "#/$defs/Participant/properties/Department"
},
"title": "Department",
"type": "array"
},
"Depiction": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
},
"title": "Context",
"type": "array"
},
"Effect": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Effect"
},
"title": "Effect",
"type": "array"
},
"Location": {
"items": {
"$ref": "#/$defs/Utility/properties/Location"
},
"title": "Location",
"type": "array"
},
"NarrativeAudio": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeAudio"
},
"title": "Narrative Audio",
"type": "array"
},
"NarrativeLocation": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
"title": "Narrative Location",
"type": "array"
},
"NarrativeObject": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject"
},
"title": "Narrative Object",
"type": "array"
},
"NarrativeScene": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene"
},
"title": "Narrative Scene",
"type": "array"
},
"NarrativeStyling": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling"
},
"title": "Narrative Styling",
"type": "array"
},
"NarrativeWardrobe": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe"
},
"title": "Narrative Wardrobe",
"type": "array"
},
"Organization": {
"items": {
"$ref": "#/$defs/Participant/properties/Organization"
},
"title": "Organization",
"type": "array"
},
"Participant": {
"items": {
"$ref": "#/$defs/Participant/properties/Participant"
},
"title": "Participant",
"type": "array"
},
"Person": {
"items": {
"$ref": "#/$defs/Participant/properties/Person"
},
"title": "Person",
"type": "array"
},
"ProductionLocation": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/ProductionLocation"
},
"title": "Production Location",
"type": "array"
},
"ProductionScene": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene"
},
"title": "Production Scene",
"type": "array"
},
"Role": {
"items": {
"$ref": "#/$defs/Participant/properties/Role"
},
"title": "Service",
"type": "array"
},
"Sequence": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
},
"title": "Sequence",
"type": "array"
},
"Service": {
"items": {
"$ref": "#/$defs/Participant/properties/Service"
},
"title": "Service",
"type": "array"
},
"Slate": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Slate"
},
"title": "Slate",
"type": "array"
},
"SpecialAction": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction"
},
"title": "Special Action",
"type": "array"
}
},
"type": "object"
},
"schemaVersion": {
"default": "https://movielabs.com/omc/json/schema/v2.0",
"description": "Describes the version of OMC-JSON schema that was used to create this instance",
"enum": [
"https://movielabs.com/omc/json/schema/v2.0"
],
"title": "Schema Version",
"type": "string"
}
},
"title": "Core",
"type": "object"
}
},
"$id": "https://movielabs.com/omc/json/schema/v2.0",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"oneOf": [
{
"$ref": "#/$defs/core/properties/rootObject"
},
{
"$ref": "#/$defs/core/properties/rootArray"
}
],
"title": "OMC-JSON schema v2.0"
} | Apache-2.0 | en |
GoogleCloudPlatform/opdio | 022143880eb8492e360276f8c3990bfa85c29fb2 | 2024-02-22T01:32:33 | api/schemas/omc-infrastructure.json | 8 | 2024-05-27T06:38:58.005247Z | {
"$comment": "Copyright 2021-2023 Motion Picture Laboratories, Inc.\nSPDX-License-Identifier: APACHE-2.0",
"$defs": {
"Infrastructure": {
"additionalProperties": false,
"properties": {
"Infrastructure": {
"additionalProperties": true,
"description": "The underlying systems and framework required for the production of the Creative Work; it is generally not specific to a particular Creative Work.",
"properties": {
"Context": {
"$ref": "#/$defs/MediaCreationContext/properties/Context",
"title": "Asset Context"
},
"InfrastructureSC": {
"$ref": "#/$defs/Infrastructure/properties/InfrastructureSC",
"title": "Structural Characteristics"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A human readable description of the asset",
"title": "Asset description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Infrastructure",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier",
"title": "Identifier"
},
"infrastructureFC": {
"$ref": "#/$defs/Infrastructure/properties/infrastructureFC",
"title": "Functional Characteristics"
},
"name": {
"description": "A human readable name for the asset",
"title": "Asset name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Infrastructure",
"type": "object"
},
"InfrastructureSC": {
"additionalProperties": false,
"description": "Describes the form of the Infrastructure along with the attributes specific to that infrastructure's form",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"entityType": {
"const": "InfrastructureSC",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"structuralProperties": {
"additionalProperties": true,
"description": "A set of properties that describe the infrastructure in this form",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
}
},
"title": "Structural Properties",
"type": [
"object",
"null"
]
},
"structuralType": {
"description": "A structured description of the the assets form",
"examples": [
"assetGroup",
"digital.image",
"analog.movingImage"
],
"title": "Structural Type",
"type": [
"string",
"null"
]
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Infrastructure Structural Characteristics",
"type": "object"
},
"infrastructureFC": {
"additionalProperties": true,
"description": "Describes the use or purpose of an Infrastructure within the production process",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"functionalProperties": {
"additionalProperties": true,
"description": "A set of properties that describe the tasks functional use",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
}
},
"title": "Functional Properties",
"type": [
"object",
"null"
]
},
"functionalType": {
"description": "The use or purpose of a Task within the production process.",
"title": "Functional Type",
"type": [
"string",
"null"
]
}
},
"title": "Infrastructure Functional Characteristics",
"type": "object"
}
},
"title": "Infrastructure Definitions",
"type": "object"
},
"Utility": {
"additionalProperties": false,
"description": "Common data models and data structures used in multiple places and in multiple ways in a larger system.",
"properties": {
"Location": {
"additionalProperties": false,
"description": "A particular place or position either in either the real world or the narrative world.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": "array"
},
"address": {
"$ref": "#/$defs/Utility/properties/address",
"title": "Address"
},
"coordinates": {
"$ref": "#/$defs/Utility/properties/coordinates",
"title": "Coordinates"
},
"description": {
"description": "A brief description of the location",
"title": "Location Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Location",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier",
"title": "Identifier"
},
"name": {
"description": "A human readable name for the location",
"title": "Location name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Location",
"type": "object"
},
"address": {
"additionalProperties": false,
"description": "A postal address or identifiable location of a place or building",
"properties": {
"country": {
"$ref": "#/$defs/Utility/properties/country",
"title": "Country"
},
"locality": {
"description": "The locality in which the street address is, and which is in the region.",
"examples": [
"Mountain View"
],
"title": "Address locality",
"type": [
"string",
"null"
]
},
"postalCode": {
"description": "A zip or postal code",
"examples": [
"94534"
],
"title": "Zip or Postal Code",
"type": [
"string",
"null"
]
},
"region": {
"description": "The region in which the locality is, and which is in the country",
"examples": [
"California"
],
"title": "Address region",
"type": [
"string",
"null"
]
},
"street": {
"description": "The street address",
"examples": [
"1600 Amphitheater Parkway"
],
"title": "Street Address",
"type": [
"string",
"null"
]
}
},
"title": "Address",
"type": [
"object",
"null"
]
},
"basicName": {
"additionalProperties": false,
"description": "A description of things name and an alternative name",
"properties": {
"altName": {
"description": "An alternate, often shortened name for the entity",
"title": "Alternate Name",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full an complete name of the entity",
"title": "Full Name",
"type": [
"string",
"null"
]
}
},
"title": "Basic Name",
"type": [
"object",
"null"
]
},
"completeName": {
"additionalProperties": false,
"description": "A detailed description of a person, or others, name and variants of their name.",
"properties": {
"alias": {
"description": "An alias being used by a person often used to disguise someones real identity, sometimes used when booking hotel rooms or restaurants ",
"title": "Alias",
"type": [
"string",
"null"
]
},
"altName": {
"title": "Alternate Name",
"type": [
"string",
"null"
]
},
"birthName": {
"description": "A persons name at birth, also referred to as maiden name",
"title": "Birth Name",
"type": [
"string",
"null"
]
},
"contractualName": {
"title": "Contractual Name",
"type": [
"string",
"null"
]
},
"displayName": {
"title": "Display Name",
"type": [
"string",
"null"
]
},
"familyName": {
"description": "A persons family name, also referred to as surname",
"title": "Family Name",
"type": [
"string",
"null"
]
},
"firstGivenName": {
"description": "A person's first name, also referred to as given name",
"title": "First Given Name",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "A complete name, typically a conjunction of familyName, firstGivenName and possibly other fields.",
"title": "Full Name",
"type": [
"string",
"null"
]
},
"moniker": {
"title": "Moniker",
"type": [
"string",
"null"
]
},
"nickname": {
"title": "Nickname",
"type": [
"string",
"null"
]
},
"prefix": {
"description": "A prefix that can indicate a persons gender or title",
"examples": [
"Mrs",
"Mr",
"Dr",
"General"
],
"title": "Prefix",
"type": [
"string",
"null"
]
},
"primaryName": {
"description": "A persons primary name, one they typically use, also often a combination of first, second and family name",
"title": "Primary Name",
"type": [
"string",
"null"
]
},
"pseudonym": {
"title": "Pseudonym",
"type": [
"string",
"null"
]
},
"scriptName": {
"title": "Script Name",
"type": [
"string",
"null"
]
},
"secondGivenName": {
"description": "A persons second given name, also referred to as middle name",
"title": "Second Given Name",
"type": [
"string",
"null"
]
},
"sortName": {
"title": "Sort Name",
"type": [
"string",
"null"
]
},
"suffix": {
"description": "A suffix, often used to indicate a title or classification",
"examples": [
"MBE",
"MD",
"RN",
"II",
"IV"
],
"title": "Suffix",
"type": [
"string",
"null"
]
},
"translatedName": {
"title": "Translated Name",
"type": [
"string",
"null"
]
}
},
"title": "Complete Name",
"type": "object"
},
"contact": {
"additionalProperties": false,
"properties": {
"email": {
"$ref": "#/$defs/Utility/properties/email",
"title": "Email"
},
"telephone": {
"$ref": "#/$defs/Utility/properties/telephone",
"title": "Telephone"
}
},
"title": "Contact",
"type": "object"
},
"coordinates": {
"additionalProperties": false,
"description": "A global positioning coordinate in compliance with WGS 84",
"properties": {
"latitude": {
"maximum": 90,
"minimum": -90,
"title": "latitude",
"type": "number"
},
"longitude": {
"maximum": 180,
"minimum": -180,
"title": "longitude",
"type": "number"
}
},
"title": "Coordinates",
"type": [
"object",
"null"
]
},
"country": {
"description": "The country, as an ISO 3166-1 alpha-2 country code",
"examples": [
"US"
],
"maxLength": 2,
"minLength": 2,
"title": "Country",
"type": [
"string",
"null"
]
},
"email": {
"additionalProperties": false,
"properties": {
"business": {
"title": "Business",
"type": [
"string",
"null"
]
},
"personal": {
"title": "Personal",
"type": [
"string",
"null"
]
}
},
"title": "Email",
"type": "object"
},
"gender": {
"additionalProperties": false,
"description": "A person, or others, expressed or prefered gender and pronoun",
"properties": {
"gender": {
"description": "The gender by which an individual identifies",
"enum": [
"male",
"female",
"other",
"unknown",
null
],
"title": "Identifies as gender",
"type": [
"string",
"null"
]
},
"genderPronoun": {
"description": "An individuals pronoun of choice",
"enum": [
"he/him",
"she/her",
"ze/hir",
"they/their",
null
],
"title": "Preferred pronoun",
"type": [
"string",
"null"
]
}
},
"title": "Gender",
"type": [
"object",
"null"
]
},
"identifier": {
"description": "An identifier uniquely identifies an entity within a particular scope.",
"items": {
"additionalProperties": false,
"properties": {
"combinedForm": {
"description": "A combination of the Identifier Scope and Value that is useful for utilizing the identifier in a system, for example a URN (URN:ID:IdentifierScope:IdentifierValue).",
"title": "Identifier Combined Form",
"type": "string"
},
"identifierScope": {
"description": "The universe within which an identifier is valid and unique.",
"title": "Identifier Scope",
"type": "string"
},
"identifierValue": {
"description": "A string of characters that uniquely identifies an object within a particular scope.",
"title": "Identifier Value",
"type": "string"
},
"url": {
"description": "A URL or IRI that can be used for resolving the Identifier Value within the Identifier Scope.",
"title": "URL",
"type": "string"
}
},
"required": [
"identifierScope",
"identifierValue"
],
"type": "object"
},
"minItems": 1,
"title": "Identifier",
"type": "array"
},
"language": {
"description": "An IETF BCP 47 language code",
"title": "Language",
"type": [
"string",
"null"
]
},
"note": {
"additionalProperties": false,
"properties": {
"text": {
"description": "The text of the note or annotation",
"title": "Text",
"type": "string"
},
"title": {
"description": "A title for the note or annotation",
"title": "Title",
"type": "string"
}
},
"title": "Note",
"type": [
"object",
"null"
]
},
"telephone": {
"additionalProperties": false,
"properties": {
"business": {
"title": "Business",
"type": [
"string",
"null"
]
},
"personal": {
"title": "Personal",
"type": [
"string",
"null"
]
}
},
"title": "Telephone",
"type": "object"
},
"time": {
"additionalProperties": false,
"properties": {
"date": {
"description": "Should be formatted to comply with ISO 8601",
"examples": [
"2020-11-21"
],
"pattern": "\\d{4}-[01]\\d-[0-3]\\d",
"title": "Date",
"type": [
"string",
"null"
]
},
"dateTime": {
"description": "Should be formatted to comply with ISO 8601",
"examples": [
"2023-08-24T20:51:15Z\n2023-08-24T20:51:15.56Z\n2023-08-24T20:51:15+08:00\n2023-08-24T20:51:15.23-04:00"
],
"pattern": "^(?:19|20)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:|\\.\\d\\d)(?:Z|-0[1-9]|-1\\d|-2[0-3]|-00:?(?:0[1-9]|[1-5]\\d)|\\+[01]\\d|\\+2[0-3])(?:|:?[0-5]\\d)$",
"title": "Date & Time",
"type": [
"string",
"null"
]
},
"descriptiveTime": {
"additionalProperties": false,
"properties": {
"eventInTime": {
"description": "Describes a specific event that occurred",
"examples": [
"Hindenburg disaster",
"World Trade Center attack",
"Queen Elizabeth coronation"
],
"title": "Event in Time",
"type": "string"
},
"periodInDay": {
"examples": [
"Morning",
"Noon",
"Midnight",
"Afternoon",
"Night"
],
"title": "Period in Day",
"type": "string"
},
"periodInTime": {
"examples": [
"Ming dynasty",
"World War II",
"Jurassic period",
"20th century"
],
"title": "Period in Time",
"type": "string"
},
"relativeTime": {
"examples": [
"Later",
"Continuous",
"6 months earlier",
"A long time ago"
],
"title": "Relative Time",
"type": "string"
}
},
"title": "Descriptive Time",
"type": "object"
},
"durationTime": {
"description": "Should be formatted to comply with ISO 8601",
"examples": [
"P2Y12M3D"
],
"pattern": "^(-?)P(?=.)((\\d+)Y)?((\\d+)M)?((\\d+)D)?(T(?=.)((\\d+)H)?((\\d+)M)?(\\d*(\\.\\d+)?S)?)?$",
"title": "Duration of Time",
"type": [
"string",
"null"
]
},
"periodInTime": {
"additionalProperties": false,
"properties": {
"durationTime": {
"title": "Duration of Time",
"type": "string"
},
"endTime": {
"title": "End Time",
"type": "string"
},
"startTime": {
"title": "Start Time",
"type": "string"
}
},
"required": [
"startTime"
],
"title": "Period in Time",
"type": "object"
},
"timecode": {
"description": "SMPTE timecode",
"examples": [
"00:03:43:12"
],
"pattern": "^(?:(?:[0-1][0-9]|[0-2][0-3]):)(?:[0-5][0-9]:){2}(?:[0-2][0-9])$",
"title": "SMPTE Timcode in the format HH:MM:SS:FF. \nAssumes the frame rate is 23.98, 24, 25, 29.97 NDF, or 30",
"type": [
"string",
"null"
]
},
"timestamp": {
"title": "Timestamp",
"type": [
"number",
"null"
]
}
},
"title": "Time",
"type": "object"
},
"unitOfMeasurement": {
"additionalProperties": false,
"properties": {
"dimensions": {
"description": "Encode a set of measurements to describe a 2 or 3 dimensional object (metric, imperial or pixels)",
"properties": {
"depth": {
"description": "The depth or Z axis of the object",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode distance using the metric system of measurement (kilometer, meter, centimetre, millimeter",
"examples": [
"100m",
"6km2m56cm12mm"
],
"pattern": "^-?(\\d+km)?(\\d+m)?(\\d+cm)?(\\d+mm)?$",
"type": "string"
},
{
"description": "Encode distance using the imperial system of measurement (miles, feet, inches)",
"examples": [
"2000ft",
"2mi12ft6in"
],
"pattern": "^-?(\\d+mi)?(\\d+ft)?(\\d+in)?$",
"type": "string"
},
{
"description": "Encode a measurement of the number of pixels, typically in a digital image",
"examples": [
"250px"
],
"pattern": "^(\\d+px)$",
"type": "string"
}
]
},
"height": {
"description": "The height or X axis of the object",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode distance using the metric system of measurement (kilometer, meter, centimetre, millimeter",
"examples": [
"100m",
"6km2m56cm12mm"
],
"pattern": "^-?(\\d+km)?(\\d+m)?(\\d+cm)?(\\d+mm)?$",
"type": "string"
},
{
"description": "Encode distance using the imperial system of measurement (miles, feet, inches)",
"examples": [
"2000ft",
"2mi12ft6in"
],
"pattern": "^-?(\\d+mi)?(\\d+ft)?(\\d+in)?$",
"type": "string"
},
{
"description": "Encode a measurement of the number of pixels, typically in a digital image",
"examples": [
"250px"
],
"pattern": "^(\\d+px)$",
"type": "string"
}
]
},
"width": {
"description": "The width or X axis of the object",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode distance using the metric system of measurement (kilometer, meter, centimetre, millimeter",
"examples": [
"100m",
"6km2m56cm12mm"
],
"pattern": "^-?(\\d+km)?(\\d+m)?(\\d+cm)?(\\d+mm)?$",
"type": "string"
},
{
"description": "Encode distance using the imperial system of measurement (miles, feet, inches)",
"examples": [
"2000ft",
"2mi12ft6in"
],
"pattern": "^-?(\\d+mi)?(\\d+ft)?(\\d+in)?$",
"type": "string"
},
{
"description": "Encode a measurement of the number of pixels, typically in a digital image",
"examples": [
"250px"
],
"pattern": "^(\\d+px)$",
"type": "string"
}
]
}
},
"title": "dimensions",
"type": "object"
},
"linearDistance": {
"description": "Encode a measurement of distance using the imperial or metric system",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode distance using the metric system of measurement (kilometer, meter, centimetre, millimeter",
"examples": [
"100m",
"6km2m56cm12mm"
],
"pattern": "^-?(\\d+km)?(\\d+m)?(\\d+cm)?(\\d+mm)?$",
"type": "string"
},
{
"description": "Encode distance using the imperial system of measurement (miles, feet, inches)",
"examples": [
"2000ft",
"2mi12ft6in"
],
"pattern": "^-?(\\d+mi)?(\\d+ft)?(\\d+in)?$",
"type": "string"
}
],
"title": "Linear Distance"
},
"weight": {
"description": "Encode a measurement of weight using the imperial or metric system",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode weight using the metric system of measurement (kilogram, gram)",
"examples": [
"3kg7g"
],
"pattern": "^(\\d+kg)?(\\d+g)?$",
"type": "string"
},
{
"description": "Encode weight using the imperial system of measurement (pounds, ounces)",
"examples": [
"12lb14oz"
],
"pattern": "^(\\d+lb)?(\\d+oz)?$",
"type": "string"
}
],
"title": "weight"
}
},
"type": "object"
},
"versionNumber": {
"description": "A designation indicating a place in a sequence of versions",
"title": "Version Number",
"type": [
"string",
"number",
"null"
]
}
},
"title": "Utility Definitions",
"type": "object"
},
"core": {
"additionalProperties": false,
"description": "Helper objects used in building the schema",
"properties": {
"customData": {
"additionalProperties": true,
"description": "A user defined set of custom data in the payload of the instance, used where the formal schema lacks required properties",
"title": "Custom Data",
"type": "object"
},
"entityInfo": {
"additionalProperties": false,
"description": "Reserved for future use to describe specific details about the instance of the entity",
"title": "Entity Information",
"type": [
"object",
"null"
]
},
"reference": {
"additionalProperties": false,
"description": "An identifier that references another entity in the graph",
"properties": {
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
}
},
"title": "Reference entity",
"type": [
"object",
"null"
]
},
"rootArray": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Character"
},
{
"$ref": "#/$defs/Participant/properties/Participant"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeAudio"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionLocation"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Slate"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Effect"
},
{
"$ref": "#/$defs/Utility/properties/Location"
},
{
"$ref": "#/$defs/Participant/properties/Role"
},
{
"$ref": "#/$defs/Participant/properties/Person"
},
{
"$ref": "#/$defs/Participant/properties/Department"
},
{
"$ref": "#/$defs/Participant/properties/Organization"
},
{
"$ref": "#/$defs/Participant/properties/Service"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
},
{
"$ref": "#/$defs/Infrastructure/properties/Infrastructure"
},
{
"$ref": "#/$defs/Infrastructure/properties/InfrastructureSC"
},
{
"$ref": "#/$defs/Task/properties/Task"
},
{
"$ref": "#/$defs/Task/properties/TaskSC"
}
]
},
"type": "array"
},
"rootObject": {
"additionalProperties": false,
"properties": {
"Asset": {
"items": {
"$ref": "#/$defs/Asset/properties/Asset"
},
"title": "Asset",
"type": "array"
},
"AssetSC": {
"items": {
"$ref": "#/$defs/Asset/properties/AssetSC"
},
"title": "Asset Structural Characteristics",
"type": "array"
},
"Character": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Character"
},
"title": "Character",
"type": "array"
},
"Context": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Context"
},
"title": "Context",
"type": "array"
},
"CreativeWork": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
},
"title": "Creative Work",
"type": "array"
},
"Department": {
"items": {
"$ref": "#/$defs/Participant/properties/Department"
},
"title": "Department",
"type": "array"
},
"Depiction": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
},
"title": "Context",
"type": "array"
},
"Effect": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Effect"
},
"title": "Effect",
"type": "array"
},
"Location": {
"items": {
"$ref": "#/$defs/Utility/properties/Location"
},
"title": "Location",
"type": "array"
},
"NarrativeAudio": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeAudio"
},
"title": "Narrative Audio",
"type": "array"
},
"NarrativeLocation": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
"title": "Narrative Location",
"type": "array"
},
"NarrativeObject": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject"
},
"title": "Narrative Object",
"type": "array"
},
"NarrativeScene": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene"
},
"title": "Narrative Scene",
"type": "array"
},
"NarrativeStyling": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling"
},
"title": "Narrative Styling",
"type": "array"
},
"NarrativeWardrobe": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe"
},
"title": "Narrative Wardrobe",
"type": "array"
},
"Organization": {
"items": {
"$ref": "#/$defs/Participant/properties/Organization"
},
"title": "Organization",
"type": "array"
},
"Participant": {
"items": {
"$ref": "#/$defs/Participant/properties/Participant"
},
"title": "Participant",
"type": "array"
},
"Person": {
"items": {
"$ref": "#/$defs/Participant/properties/Person"
},
"title": "Person",
"type": "array"
},
"ProductionLocation": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/ProductionLocation"
},
"title": "Production Location",
"type": "array"
},
"ProductionScene": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene"
},
"title": "Production Scene",
"type": "array"
},
"Role": {
"items": {
"$ref": "#/$defs/Participant/properties/Role"
},
"title": "Service",
"type": "array"
},
"Sequence": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
},
"title": "Sequence",
"type": "array"
},
"Service": {
"items": {
"$ref": "#/$defs/Participant/properties/Service"
},
"title": "Service",
"type": "array"
},
"Slate": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Slate"
},
"title": "Slate",
"type": "array"
},
"SpecialAction": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction"
},
"title": "Special Action",
"type": "array"
}
},
"type": "object"
},
"schemaVersion": {
"default": "https://movielabs.com/omc/json/schema/v2.0",
"description": "Describes the version of OMC-JSON schema that was used to create this instance",
"enum": [
"https://movielabs.com/omc/json/schema/v2.0"
],
"title": "Schema Version",
"type": "string"
}
},
"title": "Core",
"type": "object"
}
},
"$id": "https://movielabs.com/omc/json/schema/v2.0",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"oneOf": [
{
"$ref": "#/$defs/core/properties/rootObject"
},
{
"$ref": "#/$defs/core/properties/rootArray"
}
],
"title": "OMC-JSON schema v2.0"
} | Apache-2.0 | en |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.