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 |
|---|---|---|---|---|---|---|---|---|
GoogleCloudPlatform/opdio | 6cc8da0d26056561132c0cd221de939803a1624b | 2024-02-22T01:02:20 | 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"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"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"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"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"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"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"
},
"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-utility.json | 8 | 2024-05-27T06:38:58.005247Z | {
"$comment": "Copyright 2021-2023 Motion Picture Laboratories, Inc.\nSPDX-License-Identifier: APACHE-2.0",
"$defs": {
"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 | d199a388e2743924e1973e06bfd7f4e97c3e3d55 | 2024-02-22T00:19:49 | api/schemas/omc-utility.json | 8 | 2024-05-27T06:38:58.005247Z | {
"$comment": "Copyright 2021-2023 Motion Picture Laboratories, Inc.\nSPDX-License-Identifier: APACHE-2.0",
"$defs": {
"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 | 022143880eb8492e360276f8c3990bfa85c29fb2 | 2024-02-22T01:32:33 | api/schemas/omc-asset.json | 8 | 2024-05-27T06:38:58.005247Z | {
"$comment": "Copyright 2021-2023 Motion Picture Laboratories, Inc.\nSPDX-License-Identifier: APACHE-2.0",
"$defs": {
"Asset": {
"additionalProperties": false,
"properties": {
"Asset": {
"additionalProperties": false,
"description": "A physical or digital object or collection of objects specific to the creation of the Creative Work.",
"properties": {
"Asset": {
"description": "The set of Assets that make up an an asset group and has a structuralType of 'assetGroup'",
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"title": "Asset Group",
"type": [
"array",
"null"
]
},
"AssetSC": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
],
"title": "Structural Characteristics"
},
"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"
]
},
"assetFC": {
"$ref": "#/$defs/Asset/properties/assetFC",
"title": "Asset Functional Characteristics"
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"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": "Asset",
"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"
},
"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/Asset/properties/Asset"
}
]
},
"type": "array"
},
"Derivation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"type": "array"
},
"DerivationOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"Revision": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"type": "array"
},
"RevisionOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"Variant": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"type": "array"
},
"VariantOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"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": "Asset Version Information",
"type": "object"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Asset",
"type": [
"object"
]
},
"AssetSC": {
"$defs": {
"assetGroup": {
"additionalProperties": false,
"description": "Structural properties of an Asset Group",
"properties": {
"isOrdered": {
"type": [
"boolean",
"null"
]
}
},
"title": "Asset Group",
"type": "object"
},
"dimensions": {
"$ref": "#/$defs/Utility/properties/unitOfMeasurement/properties/dimensions"
},
"fileDetails": {
"additionalProperties": false,
"description": "Where opaque identifiers are used it can be useful to express naming for use in traditional file systems",
"properties": {
"fileExtension": {
"type": [
"string",
"null"
]
},
"fileName": {
"type": [
"string",
"null"
]
},
"filePath": {
"type": [
"string",
"null"
]
},
"mediaType": {
"type": [
"string",
"null"
]
}
},
"title": "File Details",
"type": "object"
},
"linkset": {
"additionalProperties": false,
"description": "When used with resolution system returning a linkset additional information can help disambiguate multiple linksets in the response.",
"properties": {
"mediaType": {
"type": [
"string",
"null"
]
},
"recordType": {
"type": [
"string",
"null"
]
}
},
"title": "Linkset",
"type": "object"
}
},
"additionalProperties": false,
"description": "Describes the form of an Asset along with the attributes specific to that asset\u2019s form",
"properties": {
"Carrier": {
"description": "For describing the physical storage device on which the digital assence is stored",
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Infrastructure/properties/Infrastructure"
}
],
"title": "Carrier"
},
"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": "AssetSC",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"isAnalog": {
"description": "True if the Asset is an Analog Asset.",
"title": "Is Analog",
"type": [
"boolean",
"null"
]
},
"name": {
"description": "A human readable name for the participant, primarily for use as a label",
"title": "Participant name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"structuralProperties": {
"additionalProperties": false,
"description": "A set of properties that describe the asset in this form",
"properties": {
"assetGroup": {
"$ref": "#/$defs/Asset/properties/AssetSC/$defs/assetGroup"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"dimensions": {
"$ref": "#/$defs/Asset/properties/AssetSC/$defs/dimensions"
},
"fileDetails": {
"$ref": "#/$defs/Asset/properties/AssetSC/$defs/fileDetails"
},
"linkset": {
"$ref": "#/$defs/Asset/properties/AssetSC/$defs/linkset"
}
},
"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"
]
},
"version": {
"additionalProperties": false,
"description": "A particular form, variant, or representation of an Asset that differs in some way from its source Asset.",
"properties": {
"DerivationOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"Deriviation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"type": "array"
},
"Representation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"type": "array"
},
"RepresentationOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"Revision": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"type": "array"
},
"RevisionOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"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": "Asset Structural Version Information",
"type": "object"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Asset Structural Characteristics",
"type": "object"
},
"assetFC": {
"$defs": {
"empty": {
"additionalProperties": false,
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
}
},
"type": "object"
},
"generic": {
"additionalProperties": false,
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"functionalProperties": {
"additionalProperties": true,
"type": [
"object",
"null"
]
},
"functionalType": {
"not": {
"enum": [
"scd"
]
},
"type": "string"
}
},
"required": [
"functionalType"
],
"type": "object"
},
"scd": {
"additionalProperties": false,
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"functionalProperties": {
"additionalProperties": false,
"properties": {
"component": {
"items": {
"properties": {
"Shot": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
],
"type": "object"
},
"duration": {
"type": [
"string",
"null"
]
},
"recordEnd": {
"type": [
"string",
"null"
]
},
"recordStart": {
"type": [
"string",
"null"
]
},
"sourceEnd": {
"type": [
"string",
"null"
]
},
"sourceStart": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"functionalType": {
"const": "scd",
"type": "string"
}
},
"required": [
"functionalType"
],
"type": "object"
}
},
"description": "Describes the use or purpose of an Asset within the production process",
"oneOf": [
{
"description": "Allow for null",
"type": "null"
},
{
"$ref": "#/$defs/Asset/properties/assetFC/$defs/empty",
"title": "Allow for empty object, no functional characteristics"
},
{
"$ref": "#/$defs/Asset/properties/assetFC/$defs/generic",
"title": "A generic schema allowing any functional type and properties"
},
{
"$ref": "#/$defs/Asset/properties/assetFC/$defs/scd",
"title": "Functional characteristics for a Sequence Chronology Descriptor"
}
],
"title": "Asset Functional Characteristics"
}
},
"title": "Asset 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 | 43b131775ebbd9a411460c48f7455cf9a624196d | 2024-02-22T01:13:05 | 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"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"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"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"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"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"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"
},
"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 | dab11b10d2c134ba72e1a8baa5af0b73ca6f05ba | 2024-02-18T21:44:02 | 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"
]
},
"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 | d4de0170ebbe0d83e5cb1f29fc97742e28c89649 | 2024-02-22T00:02:49 | 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"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"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"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"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"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"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 | dab11b10d2c134ba72e1a8baa5af0b73ca6f05ba | 2024-02-18T21:44:02 | api/schemas/omc-asset.json | 8 | 2024-05-27T06:38:58.005247Z | {
"$comment": "Copyright 2021-2023 Motion Picture Laboratories, Inc.\nSPDX-License-Identifier: APACHE-2.0",
"$defs": {
"Asset": {
"additionalProperties": false,
"properties": {
"Asset": {
"additionalProperties": false,
"description": "A physical or digital object or collection of objects specific to the creation of the Creative Work.",
"properties": {
"Asset": {
"description": "The set of Assets that make up an an asset group and has a structuralType of 'assetGroup'",
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"title": "Asset Group",
"type": [
"array",
"null"
]
},
"AssetSC": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
],
"title": "Structural Characteristics"
},
"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"
]
},
"assetFC": {
"$ref": "#/$defs/Asset/properties/assetFC",
"title": "Asset Functional Characteristics"
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"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": "Asset",
"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"
]
},
"provenance": {
"$ref": "#/$defs/Utility/properties/provenance",
"title": "Provenance"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"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/Asset/properties/Asset"
}
]
},
"type": "array"
},
"Derivation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"type": "array"
},
"DerivationOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"Revision": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"type": "array"
},
"RevisionOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"Variant": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"type": "array"
},
"VariantOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"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": "Asset Version Information",
"type": "object"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Asset",
"type": [
"object"
]
},
"AssetSC": {
"$defs": {
"assetGroup": {
"additionalProperties": false,
"description": "Structural properties of an Asset Group",
"properties": {
"isOrdered": {
"type": [
"boolean",
"null"
]
}
},
"title": "Asset Group",
"type": "object"
},
"dimensions": {
"$ref": "#/$defs/Utility/properties/unitOfMeasurement/properties/dimensions"
},
"fileDetails": {
"additionalProperties": false,
"description": "Where opaque identifiers are used it can be useful to express naming for use in traditional file systems",
"properties": {
"fileExtension": {
"type": [
"string",
"null"
]
},
"fileName": {
"type": [
"string",
"null"
]
},
"filePath": {
"type": [
"string",
"null"
]
},
"mediaType": {
"type": [
"string",
"null"
]
}
},
"title": "File Details",
"type": "object"
},
"linkset": {
"additionalProperties": false,
"description": "When used with resolution system returning a linkset additional information can help disambiguate multiple linksets in the response.",
"properties": {
"mediaType": {
"type": [
"string",
"null"
]
},
"recordType": {
"type": [
"string",
"null"
]
}
},
"title": "Linkset",
"type": "object"
}
},
"additionalProperties": false,
"description": "Describes the form of an Asset along with the attributes specific to that asset\u2019s form",
"properties": {
"Carrier": {
"description": "For describing the physical storage device on which the digital assence is stored",
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Infrastructure/properties/Infrastructure"
}
],
"title": "Carrier"
},
"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": "AssetSC",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"isAnalog": {
"description": "True if the Asset is an Analog Asset.",
"title": "Is Analog",
"type": [
"boolean",
"null"
]
},
"name": {
"description": "A human readable name for the participant, primarily for use as a label",
"title": "Participant name",
"type": [
"string",
"null"
]
},
"provenance": {
"$ref": "#/$defs/Utility/properties/provenance",
"title": "Provenance"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"structuralProperties": {
"additionalProperties": false,
"description": "A set of properties that describe the asset in this form",
"properties": {
"assetGroup": {
"$ref": "#/$defs/Asset/properties/AssetSC/$defs/assetGroup"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"dimensions": {
"$ref": "#/$defs/Asset/properties/AssetSC/$defs/dimensions"
},
"fileDetails": {
"$ref": "#/$defs/Asset/properties/AssetSC/$defs/fileDetails"
},
"linkset": {
"$ref": "#/$defs/Asset/properties/AssetSC/$defs/linkset"
}
},
"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"
]
},
"version": {
"additionalProperties": false,
"description": "A particular form, variant, or representation of an Asset that differs in some way from its source Asset.",
"properties": {
"DerivationOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"Deriviation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"type": "array"
},
"Representation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"type": "array"
},
"RepresentationOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"Revision": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"type": "array"
},
"RevisionOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"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": "Asset Structural Version Information",
"type": "object"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Asset Structural Characteristics",
"type": "object"
},
"assetFC": {
"$defs": {
"empty": {
"additionalProperties": false,
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
}
},
"type": "object"
},
"generic": {
"additionalProperties": false,
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"functionalProperties": {
"additionalProperties": true,
"type": [
"object",
"null"
]
},
"functionalType": {
"not": {
"enum": [
"scd"
]
},
"type": "string"
}
},
"required": [
"functionalType"
],
"type": "object"
},
"scd": {
"additionalProperties": false,
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"functionalProperties": {
"additionalProperties": false,
"properties": {
"component": {
"items": {
"properties": {
"Shot": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
],
"type": "object"
},
"duration": {
"type": [
"string",
"null"
]
},
"recordEnd": {
"type": [
"string",
"null"
]
},
"recordStart": {
"type": [
"string",
"null"
]
},
"sourceEnd": {
"type": [
"string",
"null"
]
},
"sourceStart": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"functionalType": {
"const": "scd",
"type": "string"
}
},
"required": [
"functionalType"
],
"type": "object"
}
},
"description": "Describes the use or purpose of an Asset within the production process",
"oneOf": [
{
"description": "Allow for null",
"type": "null"
},
{
"$ref": "#/$defs/Asset/properties/assetFC/$defs/empty",
"title": "Allow for empty object, no functional characteristics"
},
{
"$ref": "#/$defs/Asset/properties/assetFC/$defs/generic",
"title": "A generic schema allowing any functional type and properties"
},
{
"$ref": "#/$defs/Asset/properties/assetFC/$defs/scd",
"title": "Functional characteristics for a Sequence Chronology Descriptor"
}
],
"title": "Asset Functional Characteristics"
}
},
"title": "Asset 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 | dab11b10d2c134ba72e1a8baa5af0b73ca6f05ba | 2024-02-18T21:44:02 | 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"
]
},
"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 | 4c10387fc1238a9f3d73c02351b7d01e45db30f8 | 2024-02-22T01:29:26 | 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"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"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/MediaCreationContext/properties/Character"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
},
{
"$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/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/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/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Infrastructure": {
"items": {
"anyOf": [
{
"$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/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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"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/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/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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"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"
}
],
"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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"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"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"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"
}
],
"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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"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"
}
]
},
"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"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"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"
},
"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/cloud-foundation-fabric | 05ed1bf12f47603acc32820db00be079bae28933 | 2023-05-05T14:57:48 | tools/bpmetadataschema.json | 1,366 | 2024-05-29T15:25:09.178927Z | {
"$defs": {
"BlueprintActuationTool": {
"additionalProperties": false,
"properties": {
"type": {
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"BlueprintArchitecture": {
"additionalProperties": false,
"properties": {
"description": {
"items": {
"type": "string"
},
"type": "array"
},
"diagram": {
"type": "string"
}
},
"required": [
"diagram",
"description"
],
"type": "object"
},
"BlueprintAuthor": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"title": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"title"
],
"type": "object"
},
"BlueprintCloudProduct": {
"additionalProperties": false,
"properties": {
"label": {
"type": "string"
},
"pageUrl": {
"type": "string"
},
"productId": {
"type": "string"
}
},
"required": [
"pageUrl"
],
"type": "object"
},
"BlueprintContent": {
"additionalProperties": false,
"properties": {
"architecture": {
"$ref": "#/$defs/BlueprintArchitecture"
},
"diagrams": {
"items": {
"$ref": "#/$defs/BlueprintDiagram"
},
"type": "array"
},
"documentation": {
"items": {
"$ref": "#/$defs/BlueprintListContent"
},
"type": "array"
},
"examples": {
"items": {
"$ref": "#/$defs/BlueprintMiscContent"
},
"type": "array"
},
"subBlueprints": {
"items": {
"$ref": "#/$defs/BlueprintMiscContent"
},
"type": "array"
}
},
"type": "object"
},
"BlueprintCostEstimate": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"description",
"url"
],
"type": "object"
},
"BlueprintDescription": {
"additionalProperties": false,
"properties": {
"architecture": {
"items": {
"type": "string"
},
"type": "array"
},
"detailed": {
"type": "string"
},
"eulaUrls": {
"items": {
"type": "string"
},
"type": "array"
},
"html": {
"type": "string"
},
"preDeploy": {
"type": "string"
},
"tagline": {
"type": "string"
}
},
"type": "object"
},
"BlueprintDiagram": {
"additionalProperties": false,
"properties": {
"altText": {
"type": "string"
},
"description": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"BlueprintInfo": {
"additionalProperties": false,
"properties": {
"actuationTool": {
"$ref": "#/$defs/BlueprintActuationTool"
},
"author": {
"$ref": "#/$defs/BlueprintAuthor"
},
"cloudProducts": {
"items": {
"$ref": "#/$defs/BlueprintCloudProduct"
},
"type": "array"
},
"costEstimate": {
"$ref": "#/$defs/BlueprintCostEstimate"
},
"deploymentDuration": {
"$ref": "#/$defs/BlueprintTimeEstimate"
},
"description": {
"$ref": "#/$defs/BlueprintDescription"
},
"icon": {
"type": "string"
},
"quotaDetails": {
"items": {
"$ref": "#/$defs/BlueprintQuotaDetail"
},
"type": "array"
},
"softwareGroups": {
"items": {
"$ref": "#/$defs/BlueprintSoftwareGroup"
},
"type": "array"
},
"source": {
"$ref": "#/$defs/BlueprintRepoDetail"
},
"supportInfo": {
"$ref": "#/$defs/BlueprintSupport"
},
"title": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"title",
"source"
],
"type": "object"
},
"BlueprintInterface": {
"additionalProperties": false,
"properties": {
"outputs": {
"items": {
"$ref": "#/$defs/BlueprintOutput"
},
"type": "array"
},
"variableGroups": {
"items": {
"$ref": "#/$defs/BlueprintVariableGroup"
},
"type": "array"
},
"variables": {
"items": {
"$ref": "#/$defs/BlueprintVariable"
},
"type": "array"
}
},
"type": "object"
},
"BlueprintListContent": {
"additionalProperties": false,
"properties": {
"title": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"title"
],
"type": "object"
},
"BlueprintMetadata": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta"
},
"spec": {
"$ref": "#/$defs/BlueprintMetadataSpec"
}
},
"required": [
"spec"
],
"type": "object"
},
"BlueprintMetadataSpec": {
"additionalProperties": false,
"properties": {
"content": {
"$ref": "#/$defs/BlueprintContent"
},
"info": {
"$ref": "#/$defs/BlueprintInfo"
},
"interfaces": {
"$ref": "#/$defs/BlueprintInterface"
},
"requirements": {
"$ref": "#/$defs/BlueprintRequirements"
},
"ui": {
"$ref": "#/$defs/BlueprintUI"
}
},
"type": "object"
},
"BlueprintMiscContent": {
"additionalProperties": false,
"properties": {
"location": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"BlueprintOutput": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"BlueprintQuotaDetail": {
"additionalProperties": false,
"properties": {
"quotaType": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"type": {
"enum": [
"GCE_INSTANCE",
"GCE_DISK"
],
"type": "string"
},
"variable": {
"type": "string"
}
},
"required": [
"type",
"quotaType"
],
"type": "object"
},
"BlueprintRepoDetail": {
"additionalProperties": false,
"properties": {
"dir": {
"type": "string"
},
"repo": {
"type": "string"
},
"sourceType": {
"type": "string"
}
},
"required": [
"repo",
"sourceType"
],
"type": "object"
},
"BlueprintRequirements": {
"additionalProperties": false,
"properties": {
"roles": {
"items": {
"$ref": "#/$defs/BlueprintRoles"
},
"type": "array"
},
"services": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"BlueprintRoles": {
"additionalProperties": false,
"properties": {
"level": {
"type": "string"
},
"roles": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"level",
"roles"
],
"type": "object"
},
"BlueprintSoftware": {
"additionalProperties": false,
"properties": {
"licenseUrl": {
"type": "string"
},
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"title"
],
"type": "object"
},
"BlueprintSoftwareGroup": {
"additionalProperties": false,
"properties": {
"software": {
"items": {
"$ref": "#/$defs/BlueprintSoftware"
},
"type": "array"
},
"type": {
"enum": [
"UNSPECIFIED",
"OS"
],
"type": "string"
}
},
"type": "object"
},
"BlueprintSupport": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"entity": {
"type": "string"
},
"showSupportId": {
"type": "boolean"
},
"url": {
"type": "string"
}
},
"required": [
"description"
],
"type": "object"
},
"BlueprintTimeEstimate": {
"additionalProperties": false,
"properties": {
"configuration": {
"type": "integer"
},
"deployment": {
"type": "integer"
}
},
"type": "object"
},
"BlueprintUI": {
"additionalProperties": false,
"properties": {
"input": {
"$ref": "#/$defs/BlueprintUIInput"
},
"runtime": {
"$ref": "#/$defs/BlueprintUIOutput"
}
},
"type": "object"
},
"BlueprintUIInput": {
"additionalProperties": false,
"properties": {
"sections": {
"items": {
"$ref": "#/$defs/DisplaySection"
},
"type": "array"
},
"variables": {
"patternProperties": {
".*": {
"$ref": "#/$defs/DisplayVariable"
}
},
"type": "object"
}
},
"type": "object"
},
"BlueprintUIOutput": {
"additionalProperties": false,
"properties": {
"outputMessage": {
"type": "string"
},
"suggestedActions": {
"items": {
"$ref": "#/$defs/UIActionItem"
},
"type": "array"
}
},
"type": "object"
},
"BlueprintVariable": {
"additionalProperties": false,
"properties": {
"default": true,
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"BlueprintVariableGroup": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"variables": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
},
"DisplaySection": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"parent": {
"type": "string"
},
"subtext": {
"type": "string"
},
"title": {
"type": "string"
},
"tooltip": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"DisplayVariable": {
"additionalProperties": false,
"properties": {
"invisible": {
"type": "boolean"
},
"max": {
"type": "integer"
},
"maxItems": {
"type": "integer"
},
"maxLength": {
"type": "integer"
},
"min": {
"type": "integer"
},
"minItems": {
"type": "integer"
},
"minLength": {
"type": "integer"
},
"name": {
"type": "string"
},
"placeholder": {
"type": "string"
},
"regexValidation": {
"type": "string"
},
"section": {
"type": "string"
},
"title": {
"type": "string"
},
"tooltip": {
"type": "string"
},
"x-googleProperty": {
"$ref": "#/$defs/GooglePropertyExtension"
}
},
"required": [
"name"
],
"type": "object"
},
"GCEDiskSizeExtension": {
"additionalProperties": false,
"properties": {
"diskTypeVariable": {
"type": "string"
}
},
"required": [
"diskTypeVariable"
],
"type": "object"
},
"GCEExternalIPExtension": {
"additionalProperties": false,
"properties": {
"externalIpType": {
"type": "string"
},
"networkVariable": {
"type": "string"
}
},
"required": [
"networkVariable"
],
"type": "object"
},
"GCEFirewallExtension": {
"additionalProperties": false,
"properties": {
"networkVariable": {
"type": "string"
}
},
"required": [
"networkVariable"
],
"type": "object"
},
"GCEFirewallRangeExtension": {
"additionalProperties": false,
"properties": {
"firewallVariable": {
"type": "string"
}
},
"required": [
"firewallVariable"
],
"type": "object"
},
"GCEGPUCountExtension": {
"additionalProperties": false,
"properties": {
"machineTypeVariable": {
"type": "string"
}
},
"required": [
"machineTypeVariable"
],
"type": "object"
},
"GCEGPUTypeExtension": {
"additionalProperties": false,
"properties": {
"gpuType": {
"type": "string"
},
"machineType": {
"type": "string"
}
},
"required": [
"machineType"
],
"type": "object"
},
"GCEGenericResourceExtension": {
"additionalProperties": false,
"properties": {
"resourceVariable": {
"type": "string"
}
},
"required": [
"resourceVariable"
],
"type": "object"
},
"GCEIPForwardingExtension": {
"additionalProperties": false,
"properties": {
"networkVariable": {
"type": "string"
},
"notConfigurable": {
"type": "boolean"
}
},
"required": [
"networkVariable"
],
"type": "object"
},
"GCELocationExtension": {
"additionalProperties": false,
"properties": {
"allowlistedRegions": {
"items": {
"type": "string"
},
"type": "array"
},
"allowlistedZones": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GCEMachineTypeExtension": {
"additionalProperties": false,
"properties": {
"disallowCustomMachineTypes": {
"type": "boolean"
},
"minCpu": {
"type": "integer"
},
"minRamGb": {
"type": "integer"
}
},
"type": "object"
},
"GCENetworkExtension": {
"additionalProperties": false,
"properties": {
"allowSharedVpcs": {
"type": "boolean"
},
"machineTypeVariable": {
"type": "string"
}
},
"required": [
"machineTypeVariable"
],
"type": "object"
},
"GCESubnetworkExtension": {
"additionalProperties": false,
"properties": {
"networkVariable": {
"type": "string"
}
},
"required": [
"networkVariable"
],
"type": "object"
},
"GooglePropertyExtension": {
"additionalProperties": false,
"properties": {
"gceDiskSize": {
"$ref": "#/$defs/GCEDiskSizeExtension"
},
"gceExternalIp": {
"$ref": "#/$defs/GCEExternalIPExtension"
},
"gceFirewall": {
"$ref": "#/$defs/GCEFirewallExtension"
},
"gceFirewallRange": {
"$ref": "#/$defs/GCEFirewallRangeExtension"
},
"gceGpuCount": {
"$ref": "#/$defs/GCEGPUCountExtension"
},
"gceGpuType": {
"$ref": "#/$defs/GCEGPUTypeExtension"
},
"gceIpForwarding": {
"$ref": "#/$defs/GCEIPForwardingExtension"
},
"gceMachineType": {
"$ref": "#/$defs/GCEMachineTypeExtension"
},
"gceNetwork": {
"$ref": "#/$defs/GCENetworkExtension"
},
"gceRegion": {
"$ref": "#/$defs/GCELocationExtension"
},
"gceResource": {
"$ref": "#/$defs/GCEGenericResourceExtension"
},
"gceSubnetwork": {
"$ref": "#/$defs/GCESubnetworkExtension"
},
"gceZone": {
"$ref": "#/$defs/GCELocationExtension"
},
"iamServiceAccount": {
"$ref": "#/$defs/IAMServiceAccountExtension"
},
"type": {
"enum": [
"EMAIL_ADDRESS",
"MULTI_LINE_STRING",
"GCE_DISK_IMAGE",
"GCE_DISK_TYPE",
"GCE_DISK_SIZE",
"GCE_MACHINE_TYPE",
"GCE_NETWORK",
"GCE_ZONE",
"GCE_SUBNETWORK",
"GCE_REGION",
"GCE_GPU_TYPE",
"GCE_GPU_COUNT",
"GCE_EXTERNAL_IP",
"GCE_IP_FORWARDING",
"GCE_FIREWALL",
"GCE_FIREWALL_RANGE",
"GCE_GENERIC_RESOURCE",
"GCS_BUCKET",
"IAM_SERVICE_ACCOUNT"
],
"type": "string"
},
"zoneProperty": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"IAMServiceAccountExtension": {
"additionalProperties": false,
"properties": {
"roles": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"roles"
],
"type": "object"
},
"ObjectMeta": {
"additionalProperties": false,
"properties": {
"annotations": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"labels": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
}
},
"type": "object"
},
"UIActionItem": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"heading": {
"type": "string"
},
"showIf": {
"type": "string"
},
"snippet": {
"type": "string"
}
},
"required": [
"heading"
],
"type": "object"
}
},
"$id": "https://github.com/GoogleCloudPlatform/cloud-foundation-toolkit/cli/bpmetadata/blueprint-metadata",
"$ref": "#/$defs/BlueprintMetadata",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
chainguard-dev/melange | 9f0c7133427cf1054ad1734a24bb63de7ed9d302 | 2023-11-21T20:24:54 | pkg/config/schema.json | 367 | 2024-05-27T05:33:19.976056Z | {
"$defs": {
"AccountsOption": {
"additionalProperties": false,
"properties": {
"RunAs": {
"type": "string"
}
},
"required": [
"RunAs"
],
"type": "object"
},
"BuildOption": {
"additionalProperties": false,
"properties": {
"Accounts": {
"$ref": "#/$defs/AccountsOption"
},
"Contents": {
"$ref": "#/$defs/ContentsOption"
},
"Entrypoint": {
"$ref": "#/$defs/ImageEntrypoint"
},
"Environment": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"required": [
"Contents",
"Accounts",
"Environment",
"Entrypoint"
],
"type": "object"
},
"Checks": {
"additionalProperties": false,
"properties": {
"disabled": {
"description": "Optional: disable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Optional: enable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "The root melange configuration",
"properties": {
"data": {
"description": "Optional: An arbitrary list of data that can be used via templating in the\npipeline",
"items": {
"$ref": "#/$defs/RangeData"
},
"type": "array"
},
"environment": {
"$ref": "#/$defs/ImageConfiguration",
"description": "The specification for the packages build environment"
},
"options": {
"additionalProperties": {
"$ref": "#/$defs/BuildOption"
},
"description": "Optional: Deviations to the build",
"type": "object"
},
"package": {
"$ref": "#/$defs/Package",
"description": "Package metadata"
},
"pipeline": {
"description": "Required: The list of pipelines that produce the package.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"subpackages": {
"description": "Optional: The list of subpackages that this package also produces.",
"items": {
"$ref": "#/$defs/Subpackage"
},
"type": "array"
},
"update": {
"$ref": "#/$defs/Update",
"description": "Optional: The update block determining how this package is auto updated"
},
"var-transforms": {
"description": "Optional: A list of transformations to create for the builtin template\nvariables",
"items": {
"$ref": "#/$defs/VarTransforms"
},
"type": "array"
},
"vars": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: A map of arbitrary variables that can be used via templating in\nthe pipeline",
"type": "object"
}
},
"required": [
"package",
"environment"
],
"type": "object"
},
"ContentsOption": {
"additionalProperties": false,
"properties": {
"Packages": {
"$ref": "#/$defs/ListOption"
}
},
"required": [
"Packages"
],
"type": "object"
},
"Copyright": {
"additionalProperties": false,
"properties": {
"attestation": {
"description": "Optional: Attestations of the license",
"type": "string"
},
"license": {
"description": "Required: The license for this package",
"type": "string"
},
"paths": {
"description": "Optional: The license paths, typically '*'",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"license"
],
"type": "object"
},
"DataItems": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Dependencies": {
"additionalProperties": false,
"properties": {
"provider-priority": {
"description": "Optional: An integer compared against other equal package provides used to\ndetermine priority",
"type": "integer"
},
"provides": {
"description": "Optional: List of packages provided",
"items": {
"type": "string"
},
"type": "array"
},
"replaces": {
"description": "Optional: List of replace objectives",
"items": {
"type": "string"
},
"type": "array"
},
"runtime": {
"description": "Optional: List of runtime dependencies",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GitHubMonitor": {
"additionalProperties": false,
"description": "GitHubMonitor indicates using the GitHub API",
"properties": {
"identifier": {
"description": "Org/repo for GitHub",
"type": "string"
},
"strip-prefix": {
"description": "If the version in GitHub contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in GitHub contains a suffix which should be ignored",
"type": "string"
},
"tag-filter": {
"description": "Filter to apply when searching tags on a GitHub repository\nDeprecated: Use TagFilterPrefix instead",
"type": "string"
},
"tag-filter-contains": {
"description": "Filter to apply when searching tags on a GitHub repository",
"type": "string"
},
"tag-filter-prefix": {
"description": "Prefix filter to apply when searching tags on a GitHub repository",
"type": "string"
},
"use-tag": {
"description": "Override the default of using a GitHub release to identify related tag to\nfetch. Not all projects use GitHub releases but just use tags",
"type": "boolean"
}
},
"required": [
"identifier"
],
"type": "object"
},
"Group": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"groupname": {
"type": "string"
},
"members": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageAccounts": {
"additionalProperties": false,
"properties": {
"groups": {
"items": {
"$ref": "#/$defs/Group"
},
"type": "array"
},
"run-as": {
"type": "string"
},
"users": {
"items": {
"$ref": "#/$defs/User"
},
"type": "array"
}
},
"type": "object"
},
"ImageConfiguration": {
"additionalProperties": false,
"properties": {
"accounts": {
"$ref": "#/$defs/ImageAccounts"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"archs": {
"items": {
"type": "string"
},
"type": "array"
},
"cmd": {
"type": "string"
},
"contents": {
"$ref": "#/$defs/ImageContents"
},
"entrypoint": {
"$ref": "#/$defs/ImageEntrypoint"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"include": {
"type": "string"
},
"options": {
"additionalProperties": {
"$ref": "#/$defs/BuildOption"
},
"type": "object"
},
"os-release": {
"$ref": "#/$defs/OSRelease"
},
"paths": {
"items": {
"$ref": "#/$defs/PathMutation"
},
"type": "array"
},
"stop-signal": {
"type": "string"
},
"vcs-url": {
"type": "string"
},
"volumes": {
"items": {
"type": "string"
},
"type": "array"
},
"work-dir": {
"type": "string"
}
},
"type": "object"
},
"ImageContents": {
"additionalProperties": false,
"properties": {
"keyring": {
"items": {
"type": "string"
},
"type": "array"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"repositories": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageEntrypoint": {
"additionalProperties": false,
"properties": {
"command": {
"type": "string"
},
"services": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"shell-fragment": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"Input": {
"additionalProperties": false,
"properties": {
"default": {
"description": "Optional: The default value of the input. Required when the input is.",
"type": "string"
},
"description": {
"description": "Optional: The human readable description of the input",
"type": "string"
},
"required": {
"description": "Optional: A toggle denoting whether the input is required or not",
"type": "boolean"
}
},
"type": "object"
},
"ListOption": {
"additionalProperties": false,
"properties": {
"Add": {
"items": {
"type": "string"
},
"type": "array"
},
"Remove": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Add",
"Remove"
],
"type": "object"
},
"Needs": {
"additionalProperties": false,
"properties": {
"Packages": {
"description": "A list of packages needed by this pipeline",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Packages"
],
"type": "object"
},
"OSRelease": {
"additionalProperties": false,
"properties": {
"bug-report-url": {
"type": "string"
},
"home-url": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"pretty-name": {
"type": "string"
},
"version-id": {
"type": "string"
}
},
"type": "object"
},
"Package": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the package build configuration",
"type": "string"
},
"copyright": {
"description": "The list of copyrights for this package",
"items": {
"$ref": "#/$defs/Copyright"
},
"type": "array"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "List of packages to depends on"
},
"description": {
"description": "A human readable description of the package",
"type": "string"
},
"epoch": {
"description": "The monotone increasing epoch of the package",
"type": "integer"
},
"name": {
"description": "The name of the package",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets",
"description": "Optional: Executable scripts that run at various stages of the package\nlifecycle, triggered by configurable events"
},
"target-architecture": {
"description": "List of target architectures for which this package should be build for",
"items": {
"type": "string"
},
"type": "array"
},
"url": {
"description": "The URL to the package's homepage",
"type": "string"
},
"version": {
"description": "The version of the package",
"type": "string"
}
},
"required": [
"name",
"version",
"epoch"
],
"type": "object"
},
"PackageOption": {
"additionalProperties": false,
"properties": {
"no-commands": {
"description": "Optional: Mark this package as not providing any executables",
"type": "boolean"
},
"no-depends": {
"description": "Optional: Mark this package as a self contained package that does not\ndepend on any other package",
"type": "boolean"
},
"no-provides": {
"description": "Optional: Signify this package as a virtual package which does not provide\nany files, executables, libraries, etc... and is otherwise empty",
"type": "boolean"
}
},
"required": [
"no-provides",
"no-depends",
"no-commands"
],
"type": "object"
},
"PathMutation": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
},
"recursive": {
"type": "boolean"
},
"source": {
"type": "string"
},
"type": {
"type": "string"
},
"uid": {
"type": "integer"
}
},
"type": "object"
},
"Pipeline": {
"additionalProperties": false,
"properties": {
"assertions": {
"$ref": "#/$defs/PipelineAssertions",
"description": "Optional: Assertions to evaluate whether the pipeline was successful"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: environment variables to override the apko environment",
"type": "object"
},
"if": {
"description": "Optional: A condition to evaluate before running the pipeline",
"type": "string"
},
"inputs": {
"additionalProperties": {
"$ref": "#/$defs/Input"
},
"description": "Optional: A map of inputs to the pipeline",
"type": "object"
},
"label": {
"description": "Optional: Labels to apply to the pipeline",
"type": "string"
},
"name": {
"description": "Optional: A user defined name for the pipeline",
"type": "string"
},
"needs": {
"$ref": "#/$defs/Needs",
"description": "Optional: Configuration to determine any explicit dependencies this pipeline may have"
},
"pipeline": {
"description": "Optional: The list of pipelines to run.\n\nEach pipeline runs in it's own context that is not shared between other\npipelines. To share context between pipelines, nest a pipeline within an\nexisting pipeline. This can be useful when you wish to share common\nconfiguration, such as an alternative `working-directory`.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"runs": {
"description": "Optional: The command to run using the builder's shell (/bin/sh)",
"type": "string"
},
"uses": {
"description": "Optional: A named reusable pipeline to run\n\nThis can be either a pipeline builtin to melange, or a user defined named pipeline.\nFor example, to use a builtin melange pipeline:\n\t\tuses: autoconf/make",
"type": "string"
},
"with": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Arguments passed to the reusable pipelines defined in `uses`",
"type": "object"
},
"working-directory": {
"description": "Optional: The working directory of the pipeline\n\nThis defaults to the guests' build workspace (/home/build)",
"type": "string"
}
},
"type": "object"
},
"PipelineAssertions": {
"additionalProperties": false,
"properties": {
"required-steps": {
"description": "The number (an int) of required steps that must complete successfully\nwithin the asserted pipeline.",
"type": "integer"
}
},
"type": "object"
},
"RangeData": {
"additionalProperties": false,
"properties": {
"items": {
"$ref": "#/$defs/DataItems"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"items"
],
"type": "object"
},
"ReleaseMonitor": {
"additionalProperties": false,
"description": "ReleaseMonitor indicates using the API for https://release-monitoring.org/",
"properties": {
"identifier": {
"description": "Required: ID number for release monitor",
"type": "integer"
},
"strip-prefix": {
"description": "If the version in release monitor contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in release monitor contains a suffix which should be ignored",
"type": "string"
}
},
"required": [
"identifier"
],
"type": "object"
},
"Scriptlets": {
"additionalProperties": false,
"properties": {
"post-deinstall": {
"description": "Optional: The script to run after uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"post-install": {
"description": "Optional: The script to run post install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"post-upgrade": {
"description": "Optional: The script to run after upgrading. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-deinstall": {
"description": "Optional: The script to run before uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"pre-install": {
"description": "Optional: The script to run pre install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-upgrade": {
"description": "Optional: The script to run before upgrading. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"trigger": {
"additionalProperties": false,
"description": "Optional: A script to run on a custom trigger",
"properties": {
"paths": {
"items": {
"type": "string"
},
"type": "array"
},
"script": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"Subpackage": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the subpackage build configuration",
"type": "string"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "Optional: List of packages to depend on"
},
"description": {
"description": "Optional: The human readable description of the subpackage",
"type": "string"
},
"if": {
"description": "Optional: A conditional statement to evaluate for the subpackage",
"type": "string"
},
"name": {
"description": "Required: Name of the subpackage",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"pipeline": {
"description": "Optional: The list of pipelines that produce subpackage.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"range": {
"description": "Optional: The iterable used to generate multiple subpackages",
"type": "string"
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets"
},
"url": {
"description": "Optional: The URL to the package's homepage",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Update": {
"additionalProperties": false,
"description": "Update provides information used to describe how to keep the package up to date",
"properties": {
"enabled": {
"description": "Toggle if updates should occur",
"type": "boolean"
},
"github": {
"$ref": "#/$defs/GitHubMonitor",
"description": "The configuration block for updates tracked via the Github API"
},
"ignore-regex-patterns": {
"description": "A slice of regex patterns to match an upstream version and ignore",
"items": {
"type": "string"
},
"type": "array"
},
"manual": {
"description": "Indicates that this package should be manually updated, usually taking\ncare over special version numbers",
"type": "boolean"
},
"release-monitor": {
"$ref": "#/$defs/ReleaseMonitor",
"description": "The configuration block for updates tracked via release-monitoring.org"
},
"shared": {
"description": "Indicate that an update to this package requires an epoch bump of\ndownstream dependencies, e.g. golang, java",
"type": "boolean"
},
"version-separator": {
"description": "Override the version separator if it is nonstandard",
"type": "string"
},
"version-transform": {
"description": "The configuration block for transforming the `package.version` into an APK version",
"items": {
"$ref": "#/$defs/VersionTransform"
},
"type": "array"
}
},
"required": [
"enabled",
"manual"
],
"type": "object"
},
"User": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"uid": {
"type": "integer"
},
"username": {
"type": "string"
}
},
"type": "object"
},
"VarTransforms": {
"additionalProperties": false,
"properties": {
"from": {
"description": "Required: The original template variable.\n\nExample: ${{package.version}}",
"type": "string"
},
"match": {
"description": "Required: The regular expression to match against the `from` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
},
"to": {
"description": "Required: The name of the new variable to create\n\nExample: mangeled-package-version",
"type": "string"
}
},
"required": [
"from",
"match",
"replace",
"to"
],
"type": "object"
},
"VersionTransform": {
"additionalProperties": false,
"description": "VersionTransform allows mapping the package version to an APK version",
"properties": {
"match": {
"description": "Required: The regular expression to match against the `package.version` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
}
},
"required": [
"match",
"replace"
],
"type": "object"
}
},
"$id": "https://chainguard.dev/melange/pkg/config/configuration",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
chainguard-dev/melange | b4facd53a35bfa526e258ce4ded022326ffc483e | 2023-12-04T20:08:28 | pkg/config/schema.json | 367 | 2024-05-27T05:33:19.976056Z | {
"$defs": {
"AccountsOption": {
"additionalProperties": false,
"properties": {
"RunAs": {
"type": "string"
}
},
"required": [
"RunAs"
],
"type": "object"
},
"BuildOption": {
"additionalProperties": false,
"properties": {
"Accounts": {
"$ref": "#/$defs/AccountsOption"
},
"Contents": {
"$ref": "#/$defs/ContentsOption"
},
"Entrypoint": {
"$ref": "#/$defs/ImageEntrypoint"
},
"Environment": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"required": [
"Contents",
"Accounts",
"Environment",
"Entrypoint"
],
"type": "object"
},
"Checks": {
"additionalProperties": false,
"properties": {
"disabled": {
"description": "Optional: disable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Optional: enable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "The root melange configuration",
"properties": {
"data": {
"description": "Optional: An arbitrary list of data that can be used via templating in the\npipeline",
"items": {
"$ref": "#/$defs/RangeData"
},
"type": "array"
},
"environment": {
"$ref": "#/$defs/ImageConfiguration",
"description": "The specification for the packages build environment"
},
"options": {
"additionalProperties": {
"$ref": "#/$defs/BuildOption"
},
"description": "Optional: Deviations to the build",
"type": "object"
},
"package": {
"$ref": "#/$defs/Package",
"description": "Package metadata"
},
"pipeline": {
"description": "Required: The list of pipelines that produce the package.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"subpackages": {
"description": "Optional: The list of subpackages that this package also produces.",
"items": {
"$ref": "#/$defs/Subpackage"
},
"type": "array"
},
"test": {
"$ref": "#/$defs/Test",
"description": "Test section for the main package."
},
"update": {
"$ref": "#/$defs/Update",
"description": "Optional: The update block determining how this package is auto updated"
},
"var-transforms": {
"description": "Optional: A list of transformations to create for the builtin template\nvariables",
"items": {
"$ref": "#/$defs/VarTransforms"
},
"type": "array"
},
"vars": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: A map of arbitrary variables that can be used via templating in\nthe pipeline",
"type": "object"
}
},
"required": [
"package",
"environment"
],
"type": "object"
},
"ContentsOption": {
"additionalProperties": false,
"properties": {
"Packages": {
"$ref": "#/$defs/ListOption"
}
},
"required": [
"Packages"
],
"type": "object"
},
"Copyright": {
"additionalProperties": false,
"properties": {
"attestation": {
"description": "Optional: Attestations of the license",
"type": "string"
},
"license": {
"description": "Required: The license for this package",
"type": "string"
},
"paths": {
"description": "Optional: The license paths, typically '*'",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"license"
],
"type": "object"
},
"DataItems": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Dependencies": {
"additionalProperties": false,
"properties": {
"provider-priority": {
"description": "Optional: An integer compared against other equal package provides used to\ndetermine priority",
"type": "integer"
},
"provides": {
"description": "Optional: List of packages provided",
"items": {
"type": "string"
},
"type": "array"
},
"replaces": {
"description": "Optional: List of replace objectives",
"items": {
"type": "string"
},
"type": "array"
},
"runtime": {
"description": "Optional: List of runtime dependencies",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GitHubMonitor": {
"additionalProperties": false,
"description": "GitHubMonitor indicates using the GitHub API",
"properties": {
"identifier": {
"description": "Org/repo for GitHub",
"type": "string"
},
"strip-prefix": {
"description": "If the version in GitHub contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in GitHub contains a suffix which should be ignored",
"type": "string"
},
"tag-filter": {
"description": "Filter to apply when searching tags on a GitHub repository\nDeprecated: Use TagFilterPrefix instead",
"type": "string"
},
"tag-filter-contains": {
"description": "Filter to apply when searching tags on a GitHub repository",
"type": "string"
},
"tag-filter-prefix": {
"description": "Prefix filter to apply when searching tags on a GitHub repository",
"type": "string"
},
"use-tag": {
"description": "Override the default of using a GitHub release to identify related tag to\nfetch. Not all projects use GitHub releases but just use tags",
"type": "boolean"
}
},
"required": [
"identifier"
],
"type": "object"
},
"Group": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"groupname": {
"type": "string"
},
"members": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageAccounts": {
"additionalProperties": false,
"properties": {
"groups": {
"items": {
"$ref": "#/$defs/Group"
},
"type": "array"
},
"run-as": {
"type": "string"
},
"users": {
"items": {
"$ref": "#/$defs/User"
},
"type": "array"
}
},
"type": "object"
},
"ImageConfiguration": {
"additionalProperties": false,
"properties": {
"accounts": {
"$ref": "#/$defs/ImageAccounts"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"archs": {
"items": {
"type": "string"
},
"type": "array"
},
"cmd": {
"type": "string"
},
"contents": {
"$ref": "#/$defs/ImageContents"
},
"entrypoint": {
"$ref": "#/$defs/ImageEntrypoint"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"include": {
"type": "string"
},
"options": {
"additionalProperties": {
"$ref": "#/$defs/BuildOption"
},
"type": "object"
},
"os-release": {
"$ref": "#/$defs/OSRelease"
},
"paths": {
"items": {
"$ref": "#/$defs/PathMutation"
},
"type": "array"
},
"stop-signal": {
"type": "string"
},
"vcs-url": {
"type": "string"
},
"volumes": {
"items": {
"type": "string"
},
"type": "array"
},
"work-dir": {
"type": "string"
}
},
"type": "object"
},
"ImageContents": {
"additionalProperties": false,
"properties": {
"keyring": {
"items": {
"type": "string"
},
"type": "array"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"repositories": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageEntrypoint": {
"additionalProperties": false,
"properties": {
"command": {
"type": "string"
},
"services": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"shell-fragment": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"Input": {
"additionalProperties": false,
"properties": {
"default": {
"description": "Optional: The default value of the input. Required when the input is.",
"type": "string"
},
"description": {
"description": "Optional: The human readable description of the input",
"type": "string"
},
"required": {
"description": "Optional: A toggle denoting whether the input is required or not",
"type": "boolean"
}
},
"type": "object"
},
"ListOption": {
"additionalProperties": false,
"properties": {
"Add": {
"items": {
"type": "string"
},
"type": "array"
},
"Remove": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Add",
"Remove"
],
"type": "object"
},
"Needs": {
"additionalProperties": false,
"properties": {
"Packages": {
"description": "A list of packages needed by this pipeline",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Packages"
],
"type": "object"
},
"OSRelease": {
"additionalProperties": false,
"properties": {
"bug-report-url": {
"type": "string"
},
"home-url": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"pretty-name": {
"type": "string"
},
"version-id": {
"type": "string"
}
},
"type": "object"
},
"Package": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the package build configuration",
"type": "string"
},
"copyright": {
"description": "The list of copyrights for this package",
"items": {
"$ref": "#/$defs/Copyright"
},
"type": "array"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "List of packages to depends on"
},
"description": {
"description": "A human readable description of the package",
"type": "string"
},
"epoch": {
"description": "The monotone increasing epoch of the package",
"type": "integer"
},
"name": {
"description": "The name of the package",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Optional: Resources to allocate to the build."
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets",
"description": "Optional: Executable scripts that run at various stages of the package\nlifecycle, triggered by configurable events"
},
"target-architecture": {
"description": "List of target architectures for which this package should be build for",
"items": {
"type": "string"
},
"type": "array"
},
"timeout": {
"description": "Optional: The amount of time to allow this build to take before timing out.",
"type": "integer"
},
"url": {
"description": "The URL to the package's homepage",
"type": "string"
},
"version": {
"description": "The version of the package",
"type": "string"
}
},
"required": [
"name",
"version",
"epoch"
],
"type": "object"
},
"PackageOption": {
"additionalProperties": false,
"properties": {
"no-commands": {
"description": "Optional: Mark this package as not providing any executables",
"type": "boolean"
},
"no-depends": {
"description": "Optional: Mark this package as a self contained package that does not\ndepend on any other package",
"type": "boolean"
},
"no-provides": {
"description": "Optional: Signify this package as a virtual package which does not provide\nany files, executables, libraries, etc... and is otherwise empty",
"type": "boolean"
}
},
"required": [
"no-provides",
"no-depends",
"no-commands"
],
"type": "object"
},
"PathMutation": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
},
"recursive": {
"type": "boolean"
},
"source": {
"type": "string"
},
"type": {
"type": "string"
},
"uid": {
"type": "integer"
}
},
"type": "object"
},
"Pipeline": {
"additionalProperties": false,
"properties": {
"assertions": {
"$ref": "#/$defs/PipelineAssertions",
"description": "Optional: Assertions to evaluate whether the pipeline was successful"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: environment variables to override the apko environment",
"type": "object"
},
"if": {
"description": "Optional: A condition to evaluate before running the pipeline",
"type": "string"
},
"inputs": {
"additionalProperties": {
"$ref": "#/$defs/Input"
},
"description": "Optional: A map of inputs to the pipeline",
"type": "object"
},
"label": {
"description": "Optional: Labels to apply to the pipeline",
"type": "string"
},
"name": {
"description": "Optional: A user defined name for the pipeline",
"type": "string"
},
"needs": {
"$ref": "#/$defs/Needs",
"description": "Optional: Configuration to determine any explicit dependencies this pipeline may have"
},
"pipeline": {
"description": "Optional: The list of pipelines to run.\n\nEach pipeline runs in it's own context that is not shared between other\npipelines. To share context between pipelines, nest a pipeline within an\nexisting pipeline. This can be useful when you wish to share common\nconfiguration, such as an alternative `working-directory`.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"runs": {
"description": "Optional: The command to run using the builder's shell (/bin/sh)",
"type": "string"
},
"uses": {
"description": "Optional: A named reusable pipeline to run\n\nThis can be either a pipeline builtin to melange, or a user defined named pipeline.\nFor example, to use a builtin melange pipeline:\n\t\tuses: autoconf/make",
"type": "string"
},
"with": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Arguments passed to the reusable pipelines defined in `uses`",
"type": "object"
},
"working-directory": {
"description": "Optional: The working directory of the pipeline\n\nThis defaults to the guests' build workspace (/home/build)",
"type": "string"
}
},
"type": "object"
},
"PipelineAssertions": {
"additionalProperties": false,
"properties": {
"required-steps": {
"description": "The number (an int) of required steps that must complete successfully\nwithin the asserted pipeline.",
"type": "integer"
}
},
"type": "object"
},
"RangeData": {
"additionalProperties": false,
"properties": {
"items": {
"$ref": "#/$defs/DataItems"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"items"
],
"type": "object"
},
"ReleaseMonitor": {
"additionalProperties": false,
"description": "ReleaseMonitor indicates using the API for https://release-monitoring.org/",
"properties": {
"identifier": {
"description": "Required: ID number for release monitor",
"type": "integer"
},
"strip-prefix": {
"description": "If the version in release monitor contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in release monitor contains a suffix which should be ignored",
"type": "string"
}
},
"required": [
"identifier"
],
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"Scriptlets": {
"additionalProperties": false,
"properties": {
"post-deinstall": {
"description": "Optional: The script to run after uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"post-install": {
"description": "Optional: The script to run post install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"post-upgrade": {
"description": "Optional: The script to run after upgrading. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-deinstall": {
"description": "Optional: The script to run before uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"pre-install": {
"description": "Optional: The script to run pre install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-upgrade": {
"description": "Optional: The script to run before upgrading. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"trigger": {
"additionalProperties": false,
"description": "Optional: A script to run on a custom trigger",
"properties": {
"paths": {
"items": {
"type": "string"
},
"type": "array"
},
"script": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"Subpackage": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the subpackage build configuration",
"type": "string"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "Optional: List of packages to depend on"
},
"description": {
"description": "Optional: The human readable description of the subpackage",
"type": "string"
},
"if": {
"description": "Optional: A conditional statement to evaluate for the subpackage",
"type": "string"
},
"name": {
"description": "Required: Name of the subpackage",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"pipeline": {
"description": "Optional: The list of pipelines that produce subpackage.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"range": {
"description": "Optional: The iterable used to generate multiple subpackages",
"type": "string"
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets"
},
"test": {
"$ref": "#/$defs/Test",
"description": "Test section for the subpackage."
},
"url": {
"description": "Optional: The URL to the package's homepage",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Test": {
"additionalProperties": false,
"properties": {
"Environment": {
"$ref": "#/$defs/ImageConfiguration",
"description": "Additional Environment necessary for test.\nEnvironment.Contents.Packages automatically get\npackage.dependencies.runtime added to it. So, if your test needs\nno additional packages, you can leave it blank."
},
"pipeline": {
"description": "Required: The list of pipelines that test the produced package.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
}
},
"required": [
"Environment",
"pipeline"
],
"type": "object"
},
"Update": {
"additionalProperties": false,
"description": "Update provides information used to describe how to keep the package up to date",
"properties": {
"enabled": {
"description": "Toggle if updates should occur",
"type": "boolean"
},
"github": {
"$ref": "#/$defs/GitHubMonitor",
"description": "The configuration block for updates tracked via the Github API"
},
"ignore-regex-patterns": {
"description": "A slice of regex patterns to match an upstream version and ignore",
"items": {
"type": "string"
},
"type": "array"
},
"manual": {
"description": "Indicates that this package should be manually updated, usually taking\ncare over special version numbers",
"type": "boolean"
},
"release-monitor": {
"$ref": "#/$defs/ReleaseMonitor",
"description": "The configuration block for updates tracked via release-monitoring.org"
},
"shared": {
"description": "Indicate that an update to this package requires an epoch bump of\ndownstream dependencies, e.g. golang, java",
"type": "boolean"
},
"version-separator": {
"description": "Override the version separator if it is nonstandard",
"type": "string"
},
"version-transform": {
"description": "The configuration block for transforming the `package.version` into an APK version",
"items": {
"$ref": "#/$defs/VersionTransform"
},
"type": "array"
}
},
"required": [
"enabled",
"manual"
],
"type": "object"
},
"User": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"uid": {
"type": "integer"
},
"username": {
"type": "string"
}
},
"type": "object"
},
"VarTransforms": {
"additionalProperties": false,
"properties": {
"from": {
"description": "Required: The original template variable.\n\nExample: ${{package.version}}",
"type": "string"
},
"match": {
"description": "Required: The regular expression to match against the `from` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
},
"to": {
"description": "Required: The name of the new variable to create\n\nExample: mangeled-package-version",
"type": "string"
}
},
"required": [
"from",
"match",
"replace",
"to"
],
"type": "object"
},
"VersionTransform": {
"additionalProperties": false,
"description": "VersionTransform allows mapping the package version to an APK version",
"properties": {
"match": {
"description": "Required: The regular expression to match against the `package.version` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
}
},
"required": [
"match",
"replace"
],
"type": "object"
}
},
"$id": "https://chainguard.dev/melange/pkg/config/configuration",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
chainguard-dev/melange | 8617729617de65516814bc66ba9b8b0518dd3045 | 2024-01-04T20:24:53 | pkg/config/schema.json | 367 | 2024-05-27T05:33:19.976056Z | {
"$defs": {
"AccountsOption": {
"additionalProperties": false,
"properties": {
"RunAs": {
"type": "string"
}
},
"required": [
"RunAs"
],
"type": "object"
},
"BuildOption": {
"additionalProperties": false,
"properties": {
"Accounts": {
"$ref": "#/$defs/AccountsOption"
},
"Contents": {
"$ref": "#/$defs/ContentsOption"
},
"Entrypoint": {
"$ref": "#/$defs/ImageEntrypoint"
},
"Environment": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"required": [
"Contents",
"Accounts",
"Environment",
"Entrypoint"
],
"type": "object"
},
"Checks": {
"additionalProperties": false,
"properties": {
"disabled": {
"description": "Optional: disable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Optional: enable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "The root melange configuration",
"properties": {
"data": {
"description": "Optional: An arbitrary list of data that can be used via templating in the\npipeline",
"items": {
"$ref": "#/$defs/RangeData"
},
"type": "array"
},
"environment": {
"$ref": "#/$defs/ImageConfiguration",
"description": "The specification for the packages build environment"
},
"options": {
"additionalProperties": {
"$ref": "#/$defs/BuildOption"
},
"description": "Optional: Deviations to the build",
"type": "object"
},
"package": {
"$ref": "#/$defs/Package",
"description": "Package metadata"
},
"pipeline": {
"description": "Required: The list of pipelines that produce the package.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"subpackages": {
"description": "Optional: The list of subpackages that this package also produces.",
"items": {
"$ref": "#/$defs/Subpackage"
},
"type": "array"
},
"test": {
"$ref": "#/$defs/Test",
"description": "Test section for the main package."
},
"update": {
"$ref": "#/$defs/Update",
"description": "Optional: The update block determining how this package is auto updated"
},
"var-transforms": {
"description": "Optional: A list of transformations to create for the builtin template\nvariables",
"items": {
"$ref": "#/$defs/VarTransforms"
},
"type": "array"
},
"vars": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: A map of arbitrary variables that can be used via templating in\nthe pipeline",
"type": "object"
}
},
"required": [
"package",
"environment"
],
"type": "object"
},
"ContentsOption": {
"additionalProperties": false,
"properties": {
"Packages": {
"$ref": "#/$defs/ListOption"
}
},
"required": [
"Packages"
],
"type": "object"
},
"Copyright": {
"additionalProperties": false,
"properties": {
"attestation": {
"description": "Optional: Attestations of the license",
"type": "string"
},
"license": {
"description": "Required: The license for this package",
"type": "string"
},
"paths": {
"description": "Optional: The license paths, typically '*'",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"license"
],
"type": "object"
},
"DataItems": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Dependencies": {
"additionalProperties": false,
"properties": {
"provider-priority": {
"description": "Optional: An integer compared against other equal package provides used to\ndetermine priority",
"type": "integer"
},
"provides": {
"description": "Optional: List of packages provided",
"items": {
"type": "string"
},
"type": "array"
},
"replaces": {
"description": "Optional: List of replace objectives",
"items": {
"type": "string"
},
"type": "array"
},
"runtime": {
"description": "Optional: List of runtime dependencies",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GitHubMonitor": {
"additionalProperties": false,
"description": "GitHubMonitor indicates using the GitHub API",
"properties": {
"identifier": {
"description": "Org/repo for GitHub",
"type": "string"
},
"strip-prefix": {
"description": "If the version in GitHub contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in GitHub contains a suffix which should be ignored",
"type": "string"
},
"tag-filter": {
"description": "Filter to apply when searching tags on a GitHub repository\nDeprecated: Use TagFilterPrefix instead",
"type": "string"
},
"tag-filter-contains": {
"description": "Filter to apply when searching tags on a GitHub repository",
"type": "string"
},
"tag-filter-prefix": {
"description": "Prefix filter to apply when searching tags on a GitHub repository",
"type": "string"
},
"use-tag": {
"description": "Override the default of using a GitHub release to identify related tag to\nfetch. Not all projects use GitHub releases but just use tags",
"type": "boolean"
}
},
"required": [
"identifier"
],
"type": "object"
},
"Group": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"groupname": {
"type": "string"
},
"members": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageAccounts": {
"additionalProperties": false,
"properties": {
"groups": {
"items": {
"$ref": "#/$defs/Group"
},
"type": "array"
},
"run-as": {
"type": "string"
},
"users": {
"items": {
"$ref": "#/$defs/User"
},
"type": "array"
}
},
"type": "object"
},
"ImageConfiguration": {
"additionalProperties": false,
"properties": {
"accounts": {
"$ref": "#/$defs/ImageAccounts"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"archs": {
"items": {
"type": "string"
},
"type": "array"
},
"cmd": {
"type": "string"
},
"contents": {
"$ref": "#/$defs/ImageContents"
},
"entrypoint": {
"$ref": "#/$defs/ImageEntrypoint"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"include": {
"type": "string"
},
"options": {
"additionalProperties": {
"$ref": "#/$defs/BuildOption"
},
"type": "object"
},
"os-release": {
"$ref": "#/$defs/OSRelease"
},
"paths": {
"items": {
"$ref": "#/$defs/PathMutation"
},
"type": "array"
},
"stop-signal": {
"type": "string"
},
"vcs-url": {
"type": "string"
},
"volumes": {
"items": {
"type": "string"
},
"type": "array"
},
"work-dir": {
"type": "string"
}
},
"type": "object"
},
"ImageContents": {
"additionalProperties": false,
"properties": {
"keyring": {
"items": {
"type": "string"
},
"type": "array"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"repositories": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageEntrypoint": {
"additionalProperties": false,
"properties": {
"command": {
"type": "string"
},
"services": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"shell-fragment": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"Input": {
"additionalProperties": false,
"properties": {
"default": {
"description": "Optional: The default value of the input. Required when the input is.",
"type": "string"
},
"description": {
"description": "Optional: The human readable description of the input",
"type": "string"
},
"required": {
"description": "Optional: A toggle denoting whether the input is required or not",
"type": "boolean"
}
},
"type": "object"
},
"ListOption": {
"additionalProperties": false,
"properties": {
"Add": {
"items": {
"type": "string"
},
"type": "array"
},
"Remove": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Add",
"Remove"
],
"type": "object"
},
"Needs": {
"additionalProperties": false,
"properties": {
"Packages": {
"description": "A list of packages needed by this pipeline",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Packages"
],
"type": "object"
},
"OSRelease": {
"additionalProperties": false,
"properties": {
"bug-report-url": {
"type": "string"
},
"home-url": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"pretty-name": {
"type": "string"
},
"version-id": {
"type": "string"
}
},
"type": "object"
},
"Package": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the package build configuration",
"type": "string"
},
"copyright": {
"description": "The list of copyrights for this package",
"items": {
"$ref": "#/$defs/Copyright"
},
"type": "array"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "List of packages to depends on"
},
"description": {
"description": "A human readable description of the package",
"type": "string"
},
"epoch": {
"description": "The monotone increasing epoch of the package",
"type": "integer"
},
"name": {
"description": "The name of the package",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Optional: Resources to allocate to the build."
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets",
"description": "Optional: Executable scripts that run at various stages of the package\nlifecycle, triggered by configurable events"
},
"target-architecture": {
"description": "List of target architectures for which this package should be build for",
"items": {
"type": "string"
},
"type": "array"
},
"timeout": {
"description": "Optional: The amount of time to allow this build to take before timing out.",
"type": "integer"
},
"url": {
"description": "The URL to the package's homepage",
"type": "string"
},
"version": {
"description": "The version of the package",
"type": "string"
}
},
"required": [
"name",
"version",
"epoch"
],
"type": "object"
},
"PackageOption": {
"additionalProperties": false,
"properties": {
"no-commands": {
"description": "Optional: Mark this package as not providing any executables",
"type": "boolean"
},
"no-depends": {
"description": "Optional: Mark this package as a self contained package that does not\ndepend on any other package",
"type": "boolean"
},
"no-provides": {
"description": "Optional: Signify this package as a virtual package which does not provide\nany files, executables, libraries, etc... and is otherwise empty",
"type": "boolean"
}
},
"required": [
"no-provides",
"no-depends",
"no-commands"
],
"type": "object"
},
"PathMutation": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
},
"recursive": {
"type": "boolean"
},
"source": {
"type": "string"
},
"type": {
"type": "string"
},
"uid": {
"type": "integer"
}
},
"type": "object"
},
"Pipeline": {
"additionalProperties": false,
"properties": {
"assertions": {
"$ref": "#/$defs/PipelineAssertions",
"description": "Optional: Assertions to evaluate whether the pipeline was successful"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: environment variables to override the apko environment",
"type": "object"
},
"if": {
"description": "Optional: A condition to evaluate before running the pipeline",
"type": "string"
},
"inputs": {
"additionalProperties": {
"$ref": "#/$defs/Input"
},
"description": "Optional: A map of inputs to the pipeline",
"type": "object"
},
"label": {
"description": "Optional: Labels to apply to the pipeline",
"type": "string"
},
"name": {
"description": "Optional: A user defined name for the pipeline",
"type": "string"
},
"needs": {
"$ref": "#/$defs/Needs",
"description": "Optional: Configuration to determine any explicit dependencies this pipeline may have"
},
"pipeline": {
"description": "Optional: The list of pipelines to run.\n\nEach pipeline runs in it's own context that is not shared between other\npipelines. To share context between pipelines, nest a pipeline within an\nexisting pipeline. This can be useful when you wish to share common\nconfiguration, such as an alternative `working-directory`.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"runs": {
"description": "Optional: The command to run using the builder's shell (/bin/sh)",
"type": "string"
},
"uses": {
"description": "Optional: A named reusable pipeline to run\n\nThis can be either a pipeline builtin to melange, or a user defined named pipeline.\nFor example, to use a builtin melange pipeline:\n\t\tuses: autoconf/make",
"type": "string"
},
"with": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Arguments passed to the reusable pipelines defined in `uses`",
"type": "object"
},
"working-directory": {
"description": "Optional: The working directory of the pipeline\n\nThis defaults to the guests' build workspace (/home/build)",
"type": "string"
}
},
"type": "object"
},
"PipelineAssertions": {
"additionalProperties": false,
"properties": {
"required-steps": {
"description": "The number (an int) of required steps that must complete successfully\nwithin the asserted pipeline.",
"type": "integer"
}
},
"type": "object"
},
"RangeData": {
"additionalProperties": false,
"properties": {
"items": {
"$ref": "#/$defs/DataItems"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"items"
],
"type": "object"
},
"ReleaseMonitor": {
"additionalProperties": false,
"description": "ReleaseMonitor indicates using the API for https://release-monitoring.org/",
"properties": {
"identifier": {
"description": "Required: ID number for release monitor",
"type": "integer"
},
"strip-prefix": {
"description": "If the version in release monitor contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in release monitor contains a suffix which should be ignored",
"type": "string"
}
},
"required": [
"identifier"
],
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"Scriptlets": {
"additionalProperties": false,
"properties": {
"post-deinstall": {
"description": "Optional: The script to run after uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"post-install": {
"description": "Optional: The script to run post install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"post-upgrade": {
"description": "Optional: The script to run after upgrading. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-deinstall": {
"description": "Optional: The script to run before uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"pre-install": {
"description": "Optional: The script to run pre install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-upgrade": {
"description": "Optional: The script to run before upgrading. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"trigger": {
"additionalProperties": false,
"description": "Optional: A script to run on a custom trigger",
"properties": {
"paths": {
"items": {
"type": "string"
},
"type": "array"
},
"script": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"Subpackage": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the subpackage build configuration",
"type": "string"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "Optional: List of packages to depend on"
},
"description": {
"description": "Optional: The human readable description of the subpackage",
"type": "string"
},
"if": {
"description": "Optional: A conditional statement to evaluate for the subpackage",
"type": "string"
},
"name": {
"description": "Required: Name of the subpackage",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"pipeline": {
"description": "Optional: The list of pipelines that produce subpackage.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"range": {
"description": "Optional: The iterable used to generate multiple subpackages",
"type": "string"
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets"
},
"test": {
"$ref": "#/$defs/Test",
"description": "Test section for the subpackage."
},
"url": {
"description": "Optional: The URL to the package's homepage",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Test": {
"additionalProperties": false,
"properties": {
"environment": {
"$ref": "#/$defs/ImageConfiguration",
"description": "Additional Environment necessary for test.\nEnvironment.Contents.Packages automatically get\npackage.dependencies.runtime added to it. So, if your test needs\nno additional packages, you can leave it blank."
},
"pipeline": {
"description": "Required: The list of pipelines that test the produced package.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
}
},
"required": [
"environment",
"pipeline"
],
"type": "object"
},
"Update": {
"additionalProperties": false,
"description": "Update provides information used to describe how to keep the package up to date",
"properties": {
"enabled": {
"description": "Toggle if updates should occur",
"type": "boolean"
},
"github": {
"$ref": "#/$defs/GitHubMonitor",
"description": "The configuration block for updates tracked via the Github API"
},
"ignore-regex-patterns": {
"description": "A slice of regex patterns to match an upstream version and ignore",
"items": {
"type": "string"
},
"type": "array"
},
"manual": {
"description": "Indicates that this package should be manually updated, usually taking\ncare over special version numbers",
"type": "boolean"
},
"release-monitor": {
"$ref": "#/$defs/ReleaseMonitor",
"description": "The configuration block for updates tracked via release-monitoring.org"
},
"shared": {
"description": "Indicate that an update to this package requires an epoch bump of\ndownstream dependencies, e.g. golang, java",
"type": "boolean"
},
"version-separator": {
"description": "Override the version separator if it is nonstandard",
"type": "string"
},
"version-transform": {
"description": "The configuration block for transforming the `package.version` into an APK version",
"items": {
"$ref": "#/$defs/VersionTransform"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"User": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"uid": {
"type": "integer"
},
"username": {
"type": "string"
}
},
"type": "object"
},
"VarTransforms": {
"additionalProperties": false,
"properties": {
"from": {
"description": "Required: The original template variable.\n\nExample: ${{package.version}}",
"type": "string"
},
"match": {
"description": "Required: The regular expression to match against the `from` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
},
"to": {
"description": "Required: The name of the new variable to create\n\nExample: mangeled-package-version",
"type": "string"
}
},
"required": [
"from",
"match",
"replace",
"to"
],
"type": "object"
},
"VersionTransform": {
"additionalProperties": false,
"description": "VersionTransform allows mapping the package version to an APK version",
"properties": {
"match": {
"description": "Required: The regular expression to match against the `package.version` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
}
},
"required": [
"match",
"replace"
],
"type": "object"
}
},
"$id": "https://chainguard.dev/melange/pkg/config/configuration",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
chainguard-dev/melange | 1aa9b4db38ae1d95d2fd3091df35df289310c237 | 2024-05-10T22:56:27 | pkg/config/schema.json | 367 | 2024-05-27T05:33:19.976056Z | {
"$defs": {
"BaseImageDescriptor": {
"additionalProperties": false,
"properties": {
"apkindex": {
"type": "string"
},
"image": {
"type": "string"
}
},
"type": "object"
},
"BuildOption": {
"additionalProperties": false,
"description": "BuildOption describes an optional deviation to a package build.",
"properties": {
"Environment": {
"$ref": "#/$defs/EnvironmentOption"
},
"Vars": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"required": [
"Vars",
"Environment"
],
"type": "object"
},
"Checks": {
"additionalProperties": false,
"properties": {
"disabled": {
"description": "Optional: disable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Optional: enable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "The root melange configuration",
"properties": {
"data": {
"description": "Optional: An arbitrary list of data that can be used via templating in the\npipeline",
"items": {
"$ref": "#/$defs/RangeData"
},
"type": "array"
},
"environment": {
"$ref": "#/$defs/ImageConfiguration",
"description": "The specification for the packages build environment"
},
"options": {
"additionalProperties": {
"$ref": "#/$defs/BuildOption"
},
"description": "Optional: Deviations to the build",
"type": "object"
},
"package": {
"$ref": "#/$defs/Package",
"description": "Package metadata"
},
"pipeline": {
"description": "Required: The list of pipelines that produce the package.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"subpackages": {
"description": "Optional: The list of subpackages that this package also produces.",
"items": {
"$ref": "#/$defs/Subpackage"
},
"type": "array"
},
"test": {
"$ref": "#/$defs/Test",
"description": "Test section for the main package."
},
"update": {
"$ref": "#/$defs/Update",
"description": "Optional: The update block determining how this package is auto updated"
},
"var-transforms": {
"description": "Optional: A list of transformations to create for the builtin template\nvariables",
"items": {
"$ref": "#/$defs/VarTransforms"
},
"type": "array"
},
"vars": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: A map of arbitrary variables that can be used via templating in\nthe pipeline",
"type": "object"
}
},
"required": [
"package",
"environment"
],
"type": "object"
},
"ContentsOption": {
"additionalProperties": false,
"description": "ContentsOption describes an optional deviation to an apko environment's contents block.",
"properties": {
"Packages": {
"$ref": "#/$defs/ListOption"
}
},
"required": [
"Packages"
],
"type": "object"
},
"Copyright": {
"additionalProperties": false,
"properties": {
"attestation": {
"description": "Optional: Attestations of the license",
"type": "string"
},
"license": {
"description": "Required: The license for this package",
"type": "string"
},
"paths": {
"description": "Optional: The license paths, typically '*'",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"license"
],
"type": "object"
},
"DataItems": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Dependencies": {
"additionalProperties": false,
"properties": {
"provider-priority": {
"description": "Optional: An integer compared against other equal package provides used to\ndetermine priority",
"type": "integer"
},
"provides": {
"description": "Optional: List of packages provided",
"items": {
"type": "string"
},
"type": "array"
},
"replaces": {
"description": "Optional: List of replace objectives",
"items": {
"type": "string"
},
"type": "array"
},
"runtime": {
"description": "Optional: List of runtime dependencies",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"EnvironmentOption": {
"additionalProperties": false,
"description": "EnvironmentOption describes an optional deviation to an apko environment.",
"properties": {
"Contents": {
"$ref": "#/$defs/ContentsOption"
}
},
"required": [
"Contents"
],
"type": "object"
},
"GitHubMonitor": {
"additionalProperties": false,
"description": "GitHubMonitor indicates using the GitHub API",
"properties": {
"identifier": {
"description": "Org/repo for GitHub",
"type": "string"
},
"strip-prefix": {
"description": "If the version in GitHub contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in GitHub contains a suffix which should be ignored",
"type": "string"
},
"tag-filter": {
"description": "Filter to apply when searching tags on a GitHub repository\nDeprecated: Use TagFilterPrefix instead",
"type": "string"
},
"tag-filter-contains": {
"description": "Filter to apply when searching tags on a GitHub repository",
"type": "string"
},
"tag-filter-prefix": {
"description": "Prefix filter to apply when searching tags on a GitHub repository",
"type": "string"
},
"use-tag": {
"description": "Override the default of using a GitHub release to identify related tag to\nfetch. Not all projects use GitHub releases but just use tags",
"type": "boolean"
}
},
"required": [
"identifier"
],
"type": "object"
},
"Group": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"groupname": {
"type": "string"
},
"members": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageAccounts": {
"additionalProperties": false,
"properties": {
"groups": {
"items": {
"$ref": "#/$defs/Group"
},
"type": "array"
},
"run-as": {
"type": "string"
},
"users": {
"items": {
"$ref": "#/$defs/User"
},
"type": "array"
}
},
"type": "object"
},
"ImageConfiguration": {
"additionalProperties": false,
"properties": {
"accounts": {
"$ref": "#/$defs/ImageAccounts"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"archs": {
"items": {
"type": "string"
},
"type": "array"
},
"cmd": {
"type": "string"
},
"contents": {
"$ref": "#/$defs/ImageContents"
},
"entrypoint": {
"$ref": "#/$defs/ImageEntrypoint"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"include": {
"type": "string"
},
"os-release": {
"$ref": "#/$defs/OSRelease"
},
"paths": {
"items": {
"$ref": "#/$defs/PathMutation"
},
"type": "array"
},
"stop-signal": {
"type": "string"
},
"vcs-url": {
"type": "string"
},
"volumes": {
"items": {
"type": "string"
},
"type": "array"
},
"work-dir": {
"type": "string"
}
},
"type": "object"
},
"ImageContents": {
"additionalProperties": false,
"properties": {
"baseimage": {
"$ref": "#/$defs/BaseImageDescriptor"
},
"keyring": {
"items": {
"type": "string"
},
"type": "array"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"repositories": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageEntrypoint": {
"additionalProperties": false,
"properties": {
"command": {
"type": "string"
},
"services": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"shell-fragment": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"Input": {
"additionalProperties": false,
"properties": {
"default": {
"description": "Optional: The default value of the input. Required when the input is.",
"type": "string"
},
"description": {
"description": "Optional: The human readable description of the input",
"type": "string"
},
"required": {
"description": "Optional: A toggle denoting whether the input is required or not",
"type": "boolean"
}
},
"type": "object"
},
"ListOption": {
"additionalProperties": false,
"description": "ListOption describes an optional deviation to a list, for example, a list of packages.",
"properties": {
"Add": {
"items": {
"type": "string"
},
"type": "array"
},
"Remove": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Add",
"Remove"
],
"type": "object"
},
"Needs": {
"additionalProperties": false,
"properties": {
"Packages": {
"description": "A list of packages needed by this pipeline",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Packages"
],
"type": "object"
},
"OSRelease": {
"additionalProperties": false,
"properties": {
"bug-report-url": {
"type": "string"
},
"home-url": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"pretty-name": {
"type": "string"
},
"version-id": {
"type": "string"
}
},
"type": "object"
},
"Package": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the package build configuration",
"type": "string"
},
"copyright": {
"description": "The list of copyrights for this package",
"items": {
"$ref": "#/$defs/Copyright"
},
"type": "array"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "List of packages to depends on"
},
"description": {
"description": "A human readable description of the package",
"type": "string"
},
"epoch": {
"description": "The monotone increasing epoch of the package",
"type": "integer"
},
"name": {
"description": "The name of the package",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Optional: Resources to allocate to the build."
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets",
"description": "Optional: Executable scripts that run at various stages of the package\nlifecycle, triggered by configurable events"
},
"target-architecture": {
"description": "List of target architectures for which this package should be build for",
"items": {
"type": "string"
},
"type": "array"
},
"timeout": {
"description": "Optional: The amount of time to allow this build to take before timing out.",
"type": "integer"
},
"url": {
"description": "The URL to the package's homepage",
"type": "string"
},
"version": {
"description": "The version of the package",
"type": "string"
}
},
"required": [
"name",
"version",
"epoch"
],
"type": "object"
},
"PackageOption": {
"additionalProperties": false,
"properties": {
"no-commands": {
"description": "Optional: Mark this package as not providing any executables",
"type": "boolean"
},
"no-depends": {
"description": "Optional: Mark this package as a self contained package that does not\ndepend on any other package",
"type": "boolean"
},
"no-provides": {
"description": "Optional: Signify this package as a virtual package which does not provide\nany files, executables, libraries, etc... and is otherwise empty",
"type": "boolean"
}
},
"required": [
"no-provides",
"no-depends",
"no-commands"
],
"type": "object"
},
"PathMutation": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
},
"recursive": {
"type": "boolean"
},
"source": {
"type": "string"
},
"type": {
"type": "string"
},
"uid": {
"type": "integer"
}
},
"type": "object"
},
"Pipeline": {
"additionalProperties": false,
"properties": {
"assertions": {
"$ref": "#/$defs/PipelineAssertions",
"description": "Optional: Assertions to evaluate whether the pipeline was successful"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: environment variables to override the apko environment",
"type": "object"
},
"if": {
"description": "Optional: A condition to evaluate before running the pipeline",
"type": "string"
},
"inputs": {
"additionalProperties": {
"$ref": "#/$defs/Input"
},
"description": "Optional: A map of inputs to the pipeline",
"type": "object"
},
"label": {
"description": "Optional: Labels to apply to the pipeline",
"type": "string"
},
"name": {
"description": "Optional: A user defined name for the pipeline",
"type": "string"
},
"needs": {
"$ref": "#/$defs/Needs",
"description": "Optional: Configuration to determine any explicit dependencies this pipeline may have"
},
"pipeline": {
"description": "Optional: The list of pipelines to run.\n\nEach pipeline runs in it's own context that is not shared between other\npipelines. To share context between pipelines, nest a pipeline within an\nexisting pipeline. This can be useful when you wish to share common\nconfiguration, such as an alternative `working-directory`.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"runs": {
"description": "Optional: The command to run using the builder's shell (/bin/sh)",
"type": "string"
},
"uses": {
"description": "Optional: A named reusable pipeline to run\n\nThis can be either a pipeline builtin to melange, or a user defined named pipeline.\nFor example, to use a builtin melange pipeline:\n\t\tuses: autoconf/make",
"type": "string"
},
"with": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Arguments passed to the reusable pipelines defined in `uses`",
"type": "object"
},
"working-directory": {
"description": "Optional: The working directory of the pipeline\n\nThis defaults to the guests' build workspace (/home/build)",
"type": "string"
}
},
"type": "object"
},
"PipelineAssertions": {
"additionalProperties": false,
"properties": {
"required-steps": {
"description": "The number (an int) of required steps that must complete successfully\nwithin the asserted pipeline.",
"type": "integer"
}
},
"type": "object"
},
"RangeData": {
"additionalProperties": false,
"properties": {
"items": {
"$ref": "#/$defs/DataItems"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"items"
],
"type": "object"
},
"ReleaseMonitor": {
"additionalProperties": false,
"description": "ReleaseMonitor indicates using the API for https://release-monitoring.org/",
"properties": {
"identifier": {
"description": "Required: ID number for release monitor",
"type": "integer"
},
"strip-prefix": {
"description": "If the version in release monitor contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in release monitor contains a suffix which should be ignored",
"type": "string"
}
},
"required": [
"identifier"
],
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"Scriptlets": {
"additionalProperties": false,
"properties": {
"post-deinstall": {
"description": "Optional: The script to run after uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"post-install": {
"description": "Optional: The script to run post install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"post-upgrade": {
"description": "Optional: The script to run after upgrading. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-deinstall": {
"description": "Optional: The script to run before uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"pre-install": {
"description": "Optional: The script to run pre install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-upgrade": {
"description": "Optional: The script to run before upgrading. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"trigger": {
"$ref": "#/$defs/Trigger",
"description": "Optional: A script to run on a custom trigger"
}
},
"type": "object"
},
"Subpackage": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the subpackage build configuration",
"type": "string"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "Optional: List of packages to depend on"
},
"description": {
"description": "Optional: The human readable description of the subpackage",
"type": "string"
},
"if": {
"description": "Optional: A conditional statement to evaluate for the subpackage",
"type": "string"
},
"name": {
"description": "Required: Name of the subpackage",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"pipeline": {
"description": "Optional: The list of pipelines that produce subpackage.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"range": {
"description": "Optional: The iterable used to generate multiple subpackages",
"type": "string"
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets"
},
"test": {
"$ref": "#/$defs/Test",
"description": "Test section for the subpackage."
},
"url": {
"description": "Optional: The URL to the package's homepage",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Test": {
"additionalProperties": false,
"properties": {
"environment": {
"$ref": "#/$defs/ImageConfiguration",
"description": "Additional Environment necessary for test.\nEnvironment.Contents.Packages automatically get\npackage.dependencies.runtime added to it. So, if your test needs\nno additional packages, you can leave it blank."
},
"pipeline": {
"description": "Required: The list of pipelines that test the produced package.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
}
},
"required": [
"environment",
"pipeline"
],
"type": "object"
},
"Trigger": {
"additionalProperties": false,
"properties": {
"paths": {
"description": "Optional: The list of paths to monitor to trigger the script",
"items": {
"type": "string"
},
"type": "array"
},
"script": {
"description": "Optional: The script to run",
"type": "string"
}
},
"type": "object"
},
"Update": {
"additionalProperties": false,
"description": "Update provides information used to describe how to keep the package up to date",
"properties": {
"enabled": {
"description": "Toggle if updates should occur",
"type": "boolean"
},
"github": {
"$ref": "#/$defs/GitHubMonitor",
"description": "The configuration block for updates tracked via the Github API"
},
"ignore-regex-patterns": {
"description": "A slice of regex patterns to match an upstream version and ignore",
"items": {
"type": "string"
},
"type": "array"
},
"manual": {
"description": "Indicates that this package should be manually updated, usually taking\ncare over special version numbers",
"type": "boolean"
},
"release-monitor": {
"$ref": "#/$defs/ReleaseMonitor",
"description": "The configuration block for updates tracked via release-monitoring.org"
},
"shared": {
"description": "Indicate that an update to this package requires an epoch bump of\ndownstream dependencies, e.g. golang, java",
"type": "boolean"
},
"version-separator": {
"description": "Override the version separator if it is nonstandard",
"type": "string"
},
"version-transform": {
"description": "The configuration block for transforming the `package.version` into an APK version",
"items": {
"$ref": "#/$defs/VersionTransform"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"User": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"shell": {
"type": "string"
},
"uid": {
"type": "integer"
},
"username": {
"type": "string"
}
},
"type": "object"
},
"VarTransforms": {
"additionalProperties": false,
"properties": {
"from": {
"description": "Required: The original template variable.\n\nExample: ${{package.version}}",
"type": "string"
},
"match": {
"description": "Required: The regular expression to match against the `from` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
},
"to": {
"description": "Required: The name of the new variable to create\n\nExample: mangeled-package-version",
"type": "string"
}
},
"required": [
"from",
"match",
"replace",
"to"
],
"type": "object"
},
"VersionTransform": {
"additionalProperties": false,
"description": "VersionTransform allows mapping the package version to an APK version",
"properties": {
"match": {
"description": "Required: The regular expression to match against the `package.version` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
}
},
"required": [
"match",
"replace"
],
"type": "object"
}
},
"$id": "https://chainguard.dev/melange/pkg/config/configuration",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
chainguard-dev/melange | f9e1b2cb4361fc86fed624d332947ea7a69bf337 | 2024-05-23T11:52:19 | pkg/config/schema.json | 367 | 2024-05-27T05:33:19.976056Z | {
"$defs": {
"BaseImageDescriptor": {
"additionalProperties": false,
"properties": {
"apkindex": {
"type": "string"
},
"image": {
"type": "string"
}
},
"type": "object"
},
"BuildOption": {
"additionalProperties": false,
"description": "BuildOption describes an optional deviation to a package build.",
"properties": {
"Environment": {
"$ref": "#/$defs/EnvironmentOption"
},
"Vars": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"required": [
"Vars",
"Environment"
],
"type": "object"
},
"Checks": {
"additionalProperties": false,
"properties": {
"disabled": {
"description": "Optional: disable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Optional: enable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "The root melange configuration",
"properties": {
"data": {
"description": "Optional: An arbitrary list of data that can be used via templating in the\npipeline",
"items": {
"$ref": "#/$defs/RangeData"
},
"type": "array"
},
"environment": {
"$ref": "#/$defs/ImageConfiguration",
"description": "The specification for the packages build environment"
},
"options": {
"additionalProperties": {
"$ref": "#/$defs/BuildOption"
},
"description": "Optional: Deviations to the build",
"type": "object"
},
"package": {
"$ref": "#/$defs/Package",
"description": "Package metadata"
},
"pipeline": {
"description": "Required: The list of pipelines that produce the package.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"subpackages": {
"description": "Optional: The list of subpackages that this package also produces.",
"items": {
"$ref": "#/$defs/Subpackage"
},
"type": "array"
},
"test": {
"$ref": "#/$defs/Test",
"description": "Test section for the main package."
},
"update": {
"$ref": "#/$defs/Update",
"description": "Optional: The update block determining how this package is auto updated"
},
"var-transforms": {
"description": "Optional: A list of transformations to create for the builtin template\nvariables",
"items": {
"$ref": "#/$defs/VarTransforms"
},
"type": "array"
},
"vars": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: A map of arbitrary variables that can be used via templating in\nthe pipeline",
"type": "object"
}
},
"required": [
"package",
"environment"
],
"type": "object"
},
"ContentsOption": {
"additionalProperties": false,
"description": "ContentsOption describes an optional deviation to an apko environment's contents block.",
"properties": {
"Packages": {
"$ref": "#/$defs/ListOption"
}
},
"required": [
"Packages"
],
"type": "object"
},
"Copyright": {
"additionalProperties": false,
"properties": {
"attestation": {
"description": "Optional: Attestations of the license",
"type": "string"
},
"license": {
"description": "Required: The license for this package",
"type": "string"
},
"license-path": {
"description": "Optional: Path to text of the custom License Ref",
"type": "string"
},
"paths": {
"description": "Optional: The license paths, typically '*'",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"license"
],
"type": "object"
},
"DataItems": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Dependencies": {
"additionalProperties": false,
"properties": {
"provider-priority": {
"description": "Optional: An integer string compared against other equal package provides used to\ndetermine priority of provides",
"type": "string"
},
"provides": {
"description": "Optional: List of packages provided",
"items": {
"type": "string"
},
"type": "array"
},
"replaces": {
"description": "Optional: List of replace objectives",
"items": {
"type": "string"
},
"type": "array"
},
"replaces-priority": {
"description": "Optional: An integer string compared against other equal package provides used to\ndetermine priority of file replacements",
"type": "string"
},
"runtime": {
"description": "Optional: List of runtime dependencies",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"EnvironmentOption": {
"additionalProperties": false,
"description": "EnvironmentOption describes an optional deviation to an apko environment.",
"properties": {
"Contents": {
"$ref": "#/$defs/ContentsOption"
}
},
"required": [
"Contents"
],
"type": "object"
},
"GitHubMonitor": {
"additionalProperties": false,
"description": "GitHubMonitor indicates using the GitHub API",
"properties": {
"identifier": {
"description": "Org/repo for GitHub",
"type": "string"
},
"strip-prefix": {
"description": "If the version in GitHub contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in GitHub contains a suffix which should be ignored",
"type": "string"
},
"tag-filter": {
"description": "Filter to apply when searching tags on a GitHub repository\nDeprecated: Use TagFilterPrefix instead",
"type": "string"
},
"tag-filter-contains": {
"description": "Filter to apply when searching tags on a GitHub repository",
"type": "string"
},
"tag-filter-prefix": {
"description": "Prefix filter to apply when searching tags on a GitHub repository",
"type": "string"
},
"use-tag": {
"description": "Override the default of using a GitHub release to identify related tag to\nfetch. Not all projects use GitHub releases but just use tags",
"type": "boolean"
}
},
"required": [
"identifier"
],
"type": "object"
},
"Group": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"groupname": {
"type": "string"
},
"members": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageAccounts": {
"additionalProperties": false,
"properties": {
"groups": {
"items": {
"$ref": "#/$defs/Group"
},
"type": "array"
},
"run-as": {
"type": "string"
},
"users": {
"items": {
"$ref": "#/$defs/User"
},
"type": "array"
}
},
"type": "object"
},
"ImageConfiguration": {
"additionalProperties": false,
"properties": {
"accounts": {
"$ref": "#/$defs/ImageAccounts"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"archs": {
"items": {
"type": "string"
},
"type": "array"
},
"cmd": {
"type": "string"
},
"contents": {
"$ref": "#/$defs/ImageContents"
},
"entrypoint": {
"$ref": "#/$defs/ImageEntrypoint"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"include": {
"type": "string"
},
"os-release": {
"$ref": "#/$defs/OSRelease"
},
"paths": {
"items": {
"$ref": "#/$defs/PathMutation"
},
"type": "array"
},
"stop-signal": {
"type": "string"
},
"vcs-url": {
"type": "string"
},
"volumes": {
"items": {
"type": "string"
},
"type": "array"
},
"work-dir": {
"type": "string"
}
},
"type": "object"
},
"ImageContents": {
"additionalProperties": false,
"properties": {
"baseimage": {
"$ref": "#/$defs/BaseImageDescriptor"
},
"keyring": {
"items": {
"type": "string"
},
"type": "array"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"repositories": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageEntrypoint": {
"additionalProperties": false,
"properties": {
"command": {
"type": "string"
},
"services": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"shell-fragment": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"Input": {
"additionalProperties": false,
"properties": {
"default": {
"description": "Optional: The default value of the input. Required when the input is.",
"type": "string"
},
"description": {
"description": "Optional: The human readable description of the input",
"type": "string"
},
"required": {
"description": "Optional: A toggle denoting whether the input is required or not",
"type": "boolean"
}
},
"type": "object"
},
"ListOption": {
"additionalProperties": false,
"description": "ListOption describes an optional deviation to a list, for example, a list of packages.",
"properties": {
"Add": {
"items": {
"type": "string"
},
"type": "array"
},
"Remove": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Add",
"Remove"
],
"type": "object"
},
"Needs": {
"additionalProperties": false,
"properties": {
"Packages": {
"description": "A list of packages needed by this pipeline",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Packages"
],
"type": "object"
},
"OSRelease": {
"additionalProperties": false,
"properties": {
"bug-report-url": {
"type": "string"
},
"home-url": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"pretty-name": {
"type": "string"
},
"version-id": {
"type": "string"
}
},
"type": "object"
},
"Package": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the package build configuration",
"type": "string"
},
"copyright": {
"description": "The list of copyrights for this package",
"items": {
"$ref": "#/$defs/Copyright"
},
"type": "array"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "List of packages to depends on"
},
"description": {
"description": "A human readable description of the package",
"type": "string"
},
"epoch": {
"description": "The monotone increasing epoch of the package",
"type": "integer"
},
"name": {
"description": "The name of the package",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Optional: Resources to allocate to the build."
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets",
"description": "Optional: Executable scripts that run at various stages of the package\nlifecycle, triggered by configurable events"
},
"target-architecture": {
"description": "List of target architectures for which this package should be build for",
"items": {
"type": "string"
},
"type": "array"
},
"timeout": {
"description": "Optional: The amount of time to allow this build to take before timing out.",
"type": "integer"
},
"url": {
"description": "The URL to the package's homepage",
"type": "string"
},
"version": {
"description": "The version of the package",
"type": "string"
}
},
"required": [
"name",
"version",
"epoch"
],
"type": "object"
},
"PackageOption": {
"additionalProperties": false,
"properties": {
"no-commands": {
"description": "Optional: Mark this package as not providing any executables",
"type": "boolean"
},
"no-depends": {
"description": "Optional: Mark this package as a self contained package that does not\ndepend on any other package",
"type": "boolean"
},
"no-provides": {
"description": "Optional: Signify this package as a virtual package which does not provide\nany files, executables, libraries, etc... and is otherwise empty",
"type": "boolean"
}
},
"required": [
"no-provides",
"no-depends",
"no-commands"
],
"type": "object"
},
"PathMutation": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
},
"recursive": {
"type": "boolean"
},
"source": {
"type": "string"
},
"type": {
"type": "string"
},
"uid": {
"type": "integer"
}
},
"type": "object"
},
"Pipeline": {
"additionalProperties": false,
"properties": {
"assertions": {
"$ref": "#/$defs/PipelineAssertions",
"description": "Optional: Assertions to evaluate whether the pipeline was successful"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: environment variables to override the apko environment",
"type": "object"
},
"if": {
"description": "Optional: A condition to evaluate before running the pipeline",
"type": "string"
},
"inputs": {
"additionalProperties": {
"$ref": "#/$defs/Input"
},
"description": "Optional: A map of inputs to the pipeline",
"type": "object"
},
"label": {
"description": "Optional: Labels to apply to the pipeline",
"type": "string"
},
"name": {
"description": "Optional: A user defined name for the pipeline",
"type": "string"
},
"needs": {
"$ref": "#/$defs/Needs",
"description": "Optional: Configuration to determine any explicit dependencies this pipeline may have"
},
"pipeline": {
"description": "Optional: The list of pipelines to run.\n\nEach pipeline runs in it's own context that is not shared between other\npipelines. To share context between pipelines, nest a pipeline within an\nexisting pipeline. This can be useful when you wish to share common\nconfiguration, such as an alternative `working-directory`.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"runs": {
"description": "Optional: The command to run using the builder's shell (/bin/sh)",
"type": "string"
},
"uses": {
"description": "Optional: A named reusable pipeline to run\n\nThis can be either a pipeline builtin to melange, or a user defined named pipeline.\nFor example, to use a builtin melange pipeline:\n\t\tuses: autoconf/make",
"type": "string"
},
"with": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Arguments passed to the reusable pipelines defined in `uses`",
"type": "object"
},
"working-directory": {
"description": "Optional: The working directory of the pipeline\n\nThis defaults to the guests' build workspace (/home/build)",
"type": "string"
}
},
"type": "object"
},
"PipelineAssertions": {
"additionalProperties": false,
"properties": {
"required-steps": {
"description": "The number (an int) of required steps that must complete successfully\nwithin the asserted pipeline.",
"type": "integer"
}
},
"type": "object"
},
"RangeData": {
"additionalProperties": false,
"properties": {
"items": {
"$ref": "#/$defs/DataItems"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"items"
],
"type": "object"
},
"ReleaseMonitor": {
"additionalProperties": false,
"description": "ReleaseMonitor indicates using the API for https://release-monitoring.org/",
"properties": {
"identifier": {
"description": "Required: ID number for release monitor",
"type": "integer"
},
"strip-prefix": {
"description": "If the version in release monitor contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in release monitor contains a suffix which should be ignored",
"type": "string"
}
},
"required": [
"identifier"
],
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"Scriptlets": {
"additionalProperties": false,
"properties": {
"post-deinstall": {
"description": "Optional: The script to run after uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"post-install": {
"description": "Optional: The script to run post install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"post-upgrade": {
"description": "Optional: The script to run after upgrading. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-deinstall": {
"description": "Optional: The script to run before uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"pre-install": {
"description": "Optional: The script to run pre install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-upgrade": {
"description": "Optional: The script to run before upgrading. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"trigger": {
"$ref": "#/$defs/Trigger",
"description": "Optional: A script to run on a custom trigger"
}
},
"type": "object"
},
"Subpackage": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the subpackage build configuration",
"type": "string"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "Optional: List of packages to depend on"
},
"description": {
"description": "Optional: The human readable description of the subpackage",
"type": "string"
},
"if": {
"description": "Optional: A conditional statement to evaluate for the subpackage",
"type": "string"
},
"name": {
"description": "Required: Name of the subpackage",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"pipeline": {
"description": "Optional: The list of pipelines that produce subpackage.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"range": {
"description": "Optional: The iterable used to generate multiple subpackages",
"type": "string"
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets"
},
"test": {
"$ref": "#/$defs/Test",
"description": "Test section for the subpackage."
},
"url": {
"description": "Optional: The URL to the package's homepage",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Test": {
"additionalProperties": false,
"properties": {
"environment": {
"$ref": "#/$defs/ImageConfiguration",
"description": "Additional Environment necessary for test.\nEnvironment.Contents.Packages automatically get\npackage.dependencies.runtime added to it. So, if your test needs\nno additional packages, you can leave it blank."
},
"pipeline": {
"description": "Required: The list of pipelines that test the produced package.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
}
},
"required": [
"environment",
"pipeline"
],
"type": "object"
},
"Trigger": {
"additionalProperties": false,
"properties": {
"paths": {
"description": "Optional: The list of paths to monitor to trigger the script",
"items": {
"type": "string"
},
"type": "array"
},
"script": {
"description": "Optional: The script to run",
"type": "string"
}
},
"type": "object"
},
"Update": {
"additionalProperties": false,
"description": "Update provides information used to describe how to keep the package up to date",
"properties": {
"enabled": {
"description": "Toggle if updates should occur",
"type": "boolean"
},
"github": {
"$ref": "#/$defs/GitHubMonitor",
"description": "The configuration block for updates tracked via the Github API"
},
"ignore-regex-patterns": {
"description": "A slice of regex patterns to match an upstream version and ignore",
"items": {
"type": "string"
},
"type": "array"
},
"manual": {
"description": "Indicates that this package should be manually updated, usually taking\ncare over special version numbers",
"type": "boolean"
},
"release-monitor": {
"$ref": "#/$defs/ReleaseMonitor",
"description": "The configuration block for updates tracked via release-monitoring.org"
},
"shared": {
"description": "Indicate that an update to this package requires an epoch bump of\ndownstream dependencies, e.g. golang, java",
"type": "boolean"
},
"version-separator": {
"description": "Override the version separator if it is nonstandard",
"type": "string"
},
"version-transform": {
"description": "The configuration block for transforming the `package.version` into an APK version",
"items": {
"$ref": "#/$defs/VersionTransform"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"User": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"shell": {
"type": "string"
},
"uid": {
"type": "integer"
},
"username": {
"type": "string"
}
},
"type": "object"
},
"VarTransforms": {
"additionalProperties": false,
"properties": {
"from": {
"description": "Required: The original template variable.\n\nExample: ${{package.version}}",
"type": "string"
},
"match": {
"description": "Required: The regular expression to match against the `from` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
},
"to": {
"description": "Required: The name of the new variable to create\n\nExample: mangeled-package-version",
"type": "string"
}
},
"required": [
"from",
"match",
"replace",
"to"
],
"type": "object"
},
"VersionTransform": {
"additionalProperties": false,
"description": "VersionTransform allows mapping the package version to an APK version",
"properties": {
"match": {
"description": "Required: The regular expression to match against the `package.version` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
}
},
"required": [
"match",
"replace"
],
"type": "object"
}
},
"$id": "https://chainguard.dev/melange/pkg/config/configuration",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
chainguard-dev/melange | 1b8b1de16ed2cb93cd0b92f71fb1b23213f02b74 | 2024-03-07T21:02:01 | pkg/config/schema.json | 367 | 2024-05-27T05:33:19.976056Z | {
"$defs": {
"BuildOption": {
"additionalProperties": false,
"description": "BuildOption describes an optional deviation to a package build.",
"properties": {
"Environment": {
"$ref": "#/$defs/EnvironmentOption"
},
"Vars": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"required": [
"Vars",
"Environment"
],
"type": "object"
},
"Checks": {
"additionalProperties": false,
"properties": {
"disabled": {
"description": "Optional: disable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Optional: enable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "The root melange configuration",
"properties": {
"data": {
"description": "Optional: An arbitrary list of data that can be used via templating in the\npipeline",
"items": {
"$ref": "#/$defs/RangeData"
},
"type": "array"
},
"environment": {
"$ref": "#/$defs/ImageConfiguration",
"description": "The specification for the packages build environment"
},
"options": {
"additionalProperties": {
"$ref": "#/$defs/BuildOption"
},
"description": "Optional: Deviations to the build",
"type": "object"
},
"package": {
"$ref": "#/$defs/Package",
"description": "Package metadata"
},
"pipeline": {
"description": "Required: The list of pipelines that produce the package.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"subpackages": {
"description": "Optional: The list of subpackages that this package also produces.",
"items": {
"$ref": "#/$defs/Subpackage"
},
"type": "array"
},
"test": {
"$ref": "#/$defs/Test",
"description": "Test section for the main package."
},
"update": {
"$ref": "#/$defs/Update",
"description": "Optional: The update block determining how this package is auto updated"
},
"var-transforms": {
"description": "Optional: A list of transformations to create for the builtin template\nvariables",
"items": {
"$ref": "#/$defs/VarTransforms"
},
"type": "array"
},
"vars": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: A map of arbitrary variables that can be used via templating in\nthe pipeline",
"type": "object"
}
},
"required": [
"package",
"environment"
],
"type": "object"
},
"ContentsOption": {
"additionalProperties": false,
"description": "ContentsOption describes an optional deviation to an apko environment's contents block.",
"properties": {
"Packages": {
"$ref": "#/$defs/ListOption"
}
},
"required": [
"Packages"
],
"type": "object"
},
"Copyright": {
"additionalProperties": false,
"properties": {
"attestation": {
"description": "Optional: Attestations of the license",
"type": "string"
},
"license": {
"description": "Required: The license for this package",
"type": "string"
},
"paths": {
"description": "Optional: The license paths, typically '*'",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"license"
],
"type": "object"
},
"DataItems": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Dependencies": {
"additionalProperties": false,
"properties": {
"provider-priority": {
"description": "Optional: An integer compared against other equal package provides used to\ndetermine priority",
"type": "integer"
},
"provides": {
"description": "Optional: List of packages provided",
"items": {
"type": "string"
},
"type": "array"
},
"replaces": {
"description": "Optional: List of replace objectives",
"items": {
"type": "string"
},
"type": "array"
},
"runtime": {
"description": "Optional: List of runtime dependencies",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"EnvironmentOption": {
"additionalProperties": false,
"description": "EnvironmentOption describes an optional deviation to an apko environment.",
"properties": {
"Contents": {
"$ref": "#/$defs/ContentsOption"
}
},
"required": [
"Contents"
],
"type": "object"
},
"GitHubMonitor": {
"additionalProperties": false,
"description": "GitHubMonitor indicates using the GitHub API",
"properties": {
"identifier": {
"description": "Org/repo for GitHub",
"type": "string"
},
"strip-prefix": {
"description": "If the version in GitHub contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in GitHub contains a suffix which should be ignored",
"type": "string"
},
"tag-filter": {
"description": "Filter to apply when searching tags on a GitHub repository\nDeprecated: Use TagFilterPrefix instead",
"type": "string"
},
"tag-filter-contains": {
"description": "Filter to apply when searching tags on a GitHub repository",
"type": "string"
},
"tag-filter-prefix": {
"description": "Prefix filter to apply when searching tags on a GitHub repository",
"type": "string"
},
"use-tag": {
"description": "Override the default of using a GitHub release to identify related tag to\nfetch. Not all projects use GitHub releases but just use tags",
"type": "boolean"
}
},
"required": [
"identifier"
],
"type": "object"
},
"Group": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"groupname": {
"type": "string"
},
"members": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageAccounts": {
"additionalProperties": false,
"properties": {
"groups": {
"items": {
"$ref": "#/$defs/Group"
},
"type": "array"
},
"run-as": {
"type": "string"
},
"users": {
"items": {
"$ref": "#/$defs/User"
},
"type": "array"
}
},
"type": "object"
},
"ImageConfiguration": {
"additionalProperties": false,
"properties": {
"accounts": {
"$ref": "#/$defs/ImageAccounts"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"archs": {
"items": {
"type": "string"
},
"type": "array"
},
"cmd": {
"type": "string"
},
"contents": {
"$ref": "#/$defs/ImageContents"
},
"entrypoint": {
"$ref": "#/$defs/ImageEntrypoint"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"include": {
"type": "string"
},
"os-release": {
"$ref": "#/$defs/OSRelease"
},
"paths": {
"items": {
"$ref": "#/$defs/PathMutation"
},
"type": "array"
},
"stop-signal": {
"type": "string"
},
"vcs-url": {
"type": "string"
},
"volumes": {
"items": {
"type": "string"
},
"type": "array"
},
"work-dir": {
"type": "string"
}
},
"type": "object"
},
"ImageContents": {
"additionalProperties": false,
"properties": {
"keyring": {
"items": {
"type": "string"
},
"type": "array"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"repositories": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageEntrypoint": {
"additionalProperties": false,
"properties": {
"command": {
"type": "string"
},
"services": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"shell-fragment": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"Input": {
"additionalProperties": false,
"properties": {
"default": {
"description": "Optional: The default value of the input. Required when the input is.",
"type": "string"
},
"description": {
"description": "Optional: The human readable description of the input",
"type": "string"
},
"required": {
"description": "Optional: A toggle denoting whether the input is required or not",
"type": "boolean"
}
},
"type": "object"
},
"ListOption": {
"additionalProperties": false,
"description": "ListOption describes an optional deviation to a list, for example, a list of packages.",
"properties": {
"Add": {
"items": {
"type": "string"
},
"type": "array"
},
"Remove": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Add",
"Remove"
],
"type": "object"
},
"Needs": {
"additionalProperties": false,
"properties": {
"Packages": {
"description": "A list of packages needed by this pipeline",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Packages"
],
"type": "object"
},
"OSRelease": {
"additionalProperties": false,
"properties": {
"bug-report-url": {
"type": "string"
},
"home-url": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"pretty-name": {
"type": "string"
},
"version-id": {
"type": "string"
}
},
"type": "object"
},
"Package": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the package build configuration",
"type": "string"
},
"copyright": {
"description": "The list of copyrights for this package",
"items": {
"$ref": "#/$defs/Copyright"
},
"type": "array"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "List of packages to depends on"
},
"description": {
"description": "A human readable description of the package",
"type": "string"
},
"epoch": {
"description": "The monotone increasing epoch of the package",
"type": "integer"
},
"name": {
"description": "The name of the package",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Optional: Resources to allocate to the build."
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets",
"description": "Optional: Executable scripts that run at various stages of the package\nlifecycle, triggered by configurable events"
},
"target-architecture": {
"description": "List of target architectures for which this package should be build for",
"items": {
"type": "string"
},
"type": "array"
},
"timeout": {
"description": "Optional: The amount of time to allow this build to take before timing out.",
"type": "integer"
},
"url": {
"description": "The URL to the package's homepage",
"type": "string"
},
"version": {
"description": "The version of the package",
"type": "string"
}
},
"required": [
"name",
"version",
"epoch"
],
"type": "object"
},
"PackageOption": {
"additionalProperties": false,
"properties": {
"no-commands": {
"description": "Optional: Mark this package as not providing any executables",
"type": "boolean"
},
"no-depends": {
"description": "Optional: Mark this package as a self contained package that does not\ndepend on any other package",
"type": "boolean"
},
"no-provides": {
"description": "Optional: Signify this package as a virtual package which does not provide\nany files, executables, libraries, etc... and is otherwise empty",
"type": "boolean"
}
},
"required": [
"no-provides",
"no-depends",
"no-commands"
],
"type": "object"
},
"PathMutation": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
},
"recursive": {
"type": "boolean"
},
"source": {
"type": "string"
},
"type": {
"type": "string"
},
"uid": {
"type": "integer"
}
},
"type": "object"
},
"Pipeline": {
"additionalProperties": false,
"properties": {
"assertions": {
"$ref": "#/$defs/PipelineAssertions",
"description": "Optional: Assertions to evaluate whether the pipeline was successful"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: environment variables to override the apko environment",
"type": "object"
},
"if": {
"description": "Optional: A condition to evaluate before running the pipeline",
"type": "string"
},
"inputs": {
"additionalProperties": {
"$ref": "#/$defs/Input"
},
"description": "Optional: A map of inputs to the pipeline",
"type": "object"
},
"label": {
"description": "Optional: Labels to apply to the pipeline",
"type": "string"
},
"name": {
"description": "Optional: A user defined name for the pipeline",
"type": "string"
},
"needs": {
"$ref": "#/$defs/Needs",
"description": "Optional: Configuration to determine any explicit dependencies this pipeline may have"
},
"pipeline": {
"description": "Optional: The list of pipelines to run.\n\nEach pipeline runs in it's own context that is not shared between other\npipelines. To share context between pipelines, nest a pipeline within an\nexisting pipeline. This can be useful when you wish to share common\nconfiguration, such as an alternative `working-directory`.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"runs": {
"description": "Optional: The command to run using the builder's shell (/bin/sh)",
"type": "string"
},
"uses": {
"description": "Optional: A named reusable pipeline to run\n\nThis can be either a pipeline builtin to melange, or a user defined named pipeline.\nFor example, to use a builtin melange pipeline:\n\t\tuses: autoconf/make",
"type": "string"
},
"with": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Arguments passed to the reusable pipelines defined in `uses`",
"type": "object"
},
"working-directory": {
"description": "Optional: The working directory of the pipeline\n\nThis defaults to the guests' build workspace (/home/build)",
"type": "string"
}
},
"type": "object"
},
"PipelineAssertions": {
"additionalProperties": false,
"properties": {
"required-steps": {
"description": "The number (an int) of required steps that must complete successfully\nwithin the asserted pipeline.",
"type": "integer"
}
},
"type": "object"
},
"RangeData": {
"additionalProperties": false,
"properties": {
"items": {
"$ref": "#/$defs/DataItems"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"items"
],
"type": "object"
},
"ReleaseMonitor": {
"additionalProperties": false,
"description": "ReleaseMonitor indicates using the API for https://release-monitoring.org/",
"properties": {
"identifier": {
"description": "Required: ID number for release monitor",
"type": "integer"
},
"strip-prefix": {
"description": "If the version in release monitor contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in release monitor contains a suffix which should be ignored",
"type": "string"
}
},
"required": [
"identifier"
],
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"Scriptlets": {
"additionalProperties": false,
"properties": {
"post-deinstall": {
"description": "Optional: The script to run after uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"post-install": {
"description": "Optional: The script to run post install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"post-upgrade": {
"description": "Optional: The script to run after upgrading. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-deinstall": {
"description": "Optional: The script to run before uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"pre-install": {
"description": "Optional: The script to run pre install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-upgrade": {
"description": "Optional: The script to run before upgrading. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"trigger": {
"additionalProperties": false,
"description": "Optional: A script to run on a custom trigger",
"properties": {
"paths": {
"items": {
"type": "string"
},
"type": "array"
},
"script": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"Subpackage": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the subpackage build configuration",
"type": "string"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "Optional: List of packages to depend on"
},
"description": {
"description": "Optional: The human readable description of the subpackage",
"type": "string"
},
"if": {
"description": "Optional: A conditional statement to evaluate for the subpackage",
"type": "string"
},
"name": {
"description": "Required: Name of the subpackage",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"pipeline": {
"description": "Optional: The list of pipelines that produce subpackage.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"range": {
"description": "Optional: The iterable used to generate multiple subpackages",
"type": "string"
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets"
},
"test": {
"$ref": "#/$defs/Test",
"description": "Test section for the subpackage."
},
"url": {
"description": "Optional: The URL to the package's homepage",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Test": {
"additionalProperties": false,
"properties": {
"environment": {
"$ref": "#/$defs/ImageConfiguration",
"description": "Additional Environment necessary for test.\nEnvironment.Contents.Packages automatically get\npackage.dependencies.runtime added to it. So, if your test needs\nno additional packages, you can leave it blank."
},
"pipeline": {
"description": "Required: The list of pipelines that test the produced package.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
}
},
"required": [
"environment",
"pipeline"
],
"type": "object"
},
"Update": {
"additionalProperties": false,
"description": "Update provides information used to describe how to keep the package up to date",
"properties": {
"enabled": {
"description": "Toggle if updates should occur",
"type": "boolean"
},
"github": {
"$ref": "#/$defs/GitHubMonitor",
"description": "The configuration block for updates tracked via the Github API"
},
"ignore-regex-patterns": {
"description": "A slice of regex patterns to match an upstream version and ignore",
"items": {
"type": "string"
},
"type": "array"
},
"manual": {
"description": "Indicates that this package should be manually updated, usually taking\ncare over special version numbers",
"type": "boolean"
},
"release-monitor": {
"$ref": "#/$defs/ReleaseMonitor",
"description": "The configuration block for updates tracked via release-monitoring.org"
},
"shared": {
"description": "Indicate that an update to this package requires an epoch bump of\ndownstream dependencies, e.g. golang, java",
"type": "boolean"
},
"version-separator": {
"description": "Override the version separator if it is nonstandard",
"type": "string"
},
"version-transform": {
"description": "The configuration block for transforming the `package.version` into an APK version",
"items": {
"$ref": "#/$defs/VersionTransform"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"User": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"uid": {
"type": "integer"
},
"username": {
"type": "string"
}
},
"type": "object"
},
"VarTransforms": {
"additionalProperties": false,
"properties": {
"from": {
"description": "Required: The original template variable.\n\nExample: ${{package.version}}",
"type": "string"
},
"match": {
"description": "Required: The regular expression to match against the `from` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
},
"to": {
"description": "Required: The name of the new variable to create\n\nExample: mangeled-package-version",
"type": "string"
}
},
"required": [
"from",
"match",
"replace",
"to"
],
"type": "object"
},
"VersionTransform": {
"additionalProperties": false,
"description": "VersionTransform allows mapping the package version to an APK version",
"properties": {
"match": {
"description": "Required: The regular expression to match against the `package.version` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
}
},
"required": [
"match",
"replace"
],
"type": "object"
}
},
"$id": "https://chainguard.dev/melange/pkg/config/configuration",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
chainguard-dev/melange | 003617ddd7079573f30c5b66f44643f431b2e009 | 2024-05-16T18:38:13 | pkg/config/schema.json | 367 | 2024-05-27T05:33:19.976056Z | {
"$defs": {
"BaseImageDescriptor": {
"additionalProperties": false,
"properties": {
"apkindex": {
"type": "string"
},
"image": {
"type": "string"
}
},
"type": "object"
},
"BuildOption": {
"additionalProperties": false,
"description": "BuildOption describes an optional deviation to a package build.",
"properties": {
"Environment": {
"$ref": "#/$defs/EnvironmentOption"
},
"Vars": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"required": [
"Vars",
"Environment"
],
"type": "object"
},
"Checks": {
"additionalProperties": false,
"properties": {
"disabled": {
"description": "Optional: disable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Optional: enable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "The root melange configuration",
"properties": {
"data": {
"description": "Optional: An arbitrary list of data that can be used via templating in the\npipeline",
"items": {
"$ref": "#/$defs/RangeData"
},
"type": "array"
},
"environment": {
"$ref": "#/$defs/ImageConfiguration",
"description": "The specification for the packages build environment"
},
"options": {
"additionalProperties": {
"$ref": "#/$defs/BuildOption"
},
"description": "Optional: Deviations to the build",
"type": "object"
},
"package": {
"$ref": "#/$defs/Package",
"description": "Package metadata"
},
"pipeline": {
"description": "Required: The list of pipelines that produce the package.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"subpackages": {
"description": "Optional: The list of subpackages that this package also produces.",
"items": {
"$ref": "#/$defs/Subpackage"
},
"type": "array"
},
"test": {
"$ref": "#/$defs/Test",
"description": "Test section for the main package."
},
"update": {
"$ref": "#/$defs/Update",
"description": "Optional: The update block determining how this package is auto updated"
},
"var-transforms": {
"description": "Optional: A list of transformations to create for the builtin template\nvariables",
"items": {
"$ref": "#/$defs/VarTransforms"
},
"type": "array"
},
"vars": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: A map of arbitrary variables that can be used via templating in\nthe pipeline",
"type": "object"
}
},
"required": [
"package",
"environment"
],
"type": "object"
},
"ContentsOption": {
"additionalProperties": false,
"description": "ContentsOption describes an optional deviation to an apko environment's contents block.",
"properties": {
"Packages": {
"$ref": "#/$defs/ListOption"
}
},
"required": [
"Packages"
],
"type": "object"
},
"Copyright": {
"additionalProperties": false,
"properties": {
"attestation": {
"description": "Optional: Attestations of the license",
"type": "string"
},
"license": {
"description": "Required: The license for this package",
"type": "string"
},
"license-path": {
"description": "Optional: Path to text of the custom License Ref",
"type": "string"
},
"paths": {
"description": "Optional: The license paths, typically '*'",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"license"
],
"type": "object"
},
"DataItems": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Dependencies": {
"additionalProperties": false,
"properties": {
"provider-priority": {
"description": "Optional: An integer compared against other equal package provides used to\ndetermine priority",
"type": "integer"
},
"provides": {
"description": "Optional: List of packages provided",
"items": {
"type": "string"
},
"type": "array"
},
"replaces": {
"description": "Optional: List of replace objectives",
"items": {
"type": "string"
},
"type": "array"
},
"runtime": {
"description": "Optional: List of runtime dependencies",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"EnvironmentOption": {
"additionalProperties": false,
"description": "EnvironmentOption describes an optional deviation to an apko environment.",
"properties": {
"Contents": {
"$ref": "#/$defs/ContentsOption"
}
},
"required": [
"Contents"
],
"type": "object"
},
"GitHubMonitor": {
"additionalProperties": false,
"description": "GitHubMonitor indicates using the GitHub API",
"properties": {
"identifier": {
"description": "Org/repo for GitHub",
"type": "string"
},
"strip-prefix": {
"description": "If the version in GitHub contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in GitHub contains a suffix which should be ignored",
"type": "string"
},
"tag-filter": {
"description": "Filter to apply when searching tags on a GitHub repository\nDeprecated: Use TagFilterPrefix instead",
"type": "string"
},
"tag-filter-contains": {
"description": "Filter to apply when searching tags on a GitHub repository",
"type": "string"
},
"tag-filter-prefix": {
"description": "Prefix filter to apply when searching tags on a GitHub repository",
"type": "string"
},
"use-tag": {
"description": "Override the default of using a GitHub release to identify related tag to\nfetch. Not all projects use GitHub releases but just use tags",
"type": "boolean"
}
},
"required": [
"identifier"
],
"type": "object"
},
"Group": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"groupname": {
"type": "string"
},
"members": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageAccounts": {
"additionalProperties": false,
"properties": {
"groups": {
"items": {
"$ref": "#/$defs/Group"
},
"type": "array"
},
"run-as": {
"type": "string"
},
"users": {
"items": {
"$ref": "#/$defs/User"
},
"type": "array"
}
},
"type": "object"
},
"ImageConfiguration": {
"additionalProperties": false,
"properties": {
"accounts": {
"$ref": "#/$defs/ImageAccounts"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"archs": {
"items": {
"type": "string"
},
"type": "array"
},
"cmd": {
"type": "string"
},
"contents": {
"$ref": "#/$defs/ImageContents"
},
"entrypoint": {
"$ref": "#/$defs/ImageEntrypoint"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"include": {
"type": "string"
},
"os-release": {
"$ref": "#/$defs/OSRelease"
},
"paths": {
"items": {
"$ref": "#/$defs/PathMutation"
},
"type": "array"
},
"stop-signal": {
"type": "string"
},
"vcs-url": {
"type": "string"
},
"volumes": {
"items": {
"type": "string"
},
"type": "array"
},
"work-dir": {
"type": "string"
}
},
"type": "object"
},
"ImageContents": {
"additionalProperties": false,
"properties": {
"baseimage": {
"$ref": "#/$defs/BaseImageDescriptor"
},
"keyring": {
"items": {
"type": "string"
},
"type": "array"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"repositories": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageEntrypoint": {
"additionalProperties": false,
"properties": {
"command": {
"type": "string"
},
"services": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"shell-fragment": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"Input": {
"additionalProperties": false,
"properties": {
"default": {
"description": "Optional: The default value of the input. Required when the input is.",
"type": "string"
},
"description": {
"description": "Optional: The human readable description of the input",
"type": "string"
},
"required": {
"description": "Optional: A toggle denoting whether the input is required or not",
"type": "boolean"
}
},
"type": "object"
},
"ListOption": {
"additionalProperties": false,
"description": "ListOption describes an optional deviation to a list, for example, a list of packages.",
"properties": {
"Add": {
"items": {
"type": "string"
},
"type": "array"
},
"Remove": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Add",
"Remove"
],
"type": "object"
},
"Needs": {
"additionalProperties": false,
"properties": {
"Packages": {
"description": "A list of packages needed by this pipeline",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Packages"
],
"type": "object"
},
"OSRelease": {
"additionalProperties": false,
"properties": {
"bug-report-url": {
"type": "string"
},
"home-url": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"pretty-name": {
"type": "string"
},
"version-id": {
"type": "string"
}
},
"type": "object"
},
"Package": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the package build configuration",
"type": "string"
},
"copyright": {
"description": "The list of copyrights for this package",
"items": {
"$ref": "#/$defs/Copyright"
},
"type": "array"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "List of packages to depends on"
},
"description": {
"description": "A human readable description of the package",
"type": "string"
},
"epoch": {
"description": "The monotone increasing epoch of the package",
"type": "integer"
},
"name": {
"description": "The name of the package",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Optional: Resources to allocate to the build."
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets",
"description": "Optional: Executable scripts that run at various stages of the package\nlifecycle, triggered by configurable events"
},
"target-architecture": {
"description": "List of target architectures for which this package should be build for",
"items": {
"type": "string"
},
"type": "array"
},
"timeout": {
"description": "Optional: The amount of time to allow this build to take before timing out.",
"type": "integer"
},
"url": {
"description": "The URL to the package's homepage",
"type": "string"
},
"version": {
"description": "The version of the package",
"type": "string"
}
},
"required": [
"name",
"version",
"epoch"
],
"type": "object"
},
"PackageOption": {
"additionalProperties": false,
"properties": {
"no-commands": {
"description": "Optional: Mark this package as not providing any executables",
"type": "boolean"
},
"no-depends": {
"description": "Optional: Mark this package as a self contained package that does not\ndepend on any other package",
"type": "boolean"
},
"no-provides": {
"description": "Optional: Signify this package as a virtual package which does not provide\nany files, executables, libraries, etc... and is otherwise empty",
"type": "boolean"
}
},
"required": [
"no-provides",
"no-depends",
"no-commands"
],
"type": "object"
},
"PathMutation": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
},
"recursive": {
"type": "boolean"
},
"source": {
"type": "string"
},
"type": {
"type": "string"
},
"uid": {
"type": "integer"
}
},
"type": "object"
},
"Pipeline": {
"additionalProperties": false,
"properties": {
"assertions": {
"$ref": "#/$defs/PipelineAssertions",
"description": "Optional: Assertions to evaluate whether the pipeline was successful"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: environment variables to override the apko environment",
"type": "object"
},
"if": {
"description": "Optional: A condition to evaluate before running the pipeline",
"type": "string"
},
"inputs": {
"additionalProperties": {
"$ref": "#/$defs/Input"
},
"description": "Optional: A map of inputs to the pipeline",
"type": "object"
},
"label": {
"description": "Optional: Labels to apply to the pipeline",
"type": "string"
},
"name": {
"description": "Optional: A user defined name for the pipeline",
"type": "string"
},
"needs": {
"$ref": "#/$defs/Needs",
"description": "Optional: Configuration to determine any explicit dependencies this pipeline may have"
},
"pipeline": {
"description": "Optional: The list of pipelines to run.\n\nEach pipeline runs in it's own context that is not shared between other\npipelines. To share context between pipelines, nest a pipeline within an\nexisting pipeline. This can be useful when you wish to share common\nconfiguration, such as an alternative `working-directory`.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"runs": {
"description": "Optional: The command to run using the builder's shell (/bin/sh)",
"type": "string"
},
"uses": {
"description": "Optional: A named reusable pipeline to run\n\nThis can be either a pipeline builtin to melange, or a user defined named pipeline.\nFor example, to use a builtin melange pipeline:\n\t\tuses: autoconf/make",
"type": "string"
},
"with": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Arguments passed to the reusable pipelines defined in `uses`",
"type": "object"
},
"working-directory": {
"description": "Optional: The working directory of the pipeline\n\nThis defaults to the guests' build workspace (/home/build)",
"type": "string"
}
},
"type": "object"
},
"PipelineAssertions": {
"additionalProperties": false,
"properties": {
"required-steps": {
"description": "The number (an int) of required steps that must complete successfully\nwithin the asserted pipeline.",
"type": "integer"
}
},
"type": "object"
},
"RangeData": {
"additionalProperties": false,
"properties": {
"items": {
"$ref": "#/$defs/DataItems"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"items"
],
"type": "object"
},
"ReleaseMonitor": {
"additionalProperties": false,
"description": "ReleaseMonitor indicates using the API for https://release-monitoring.org/",
"properties": {
"identifier": {
"description": "Required: ID number for release monitor",
"type": "integer"
},
"strip-prefix": {
"description": "If the version in release monitor contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in release monitor contains a suffix which should be ignored",
"type": "string"
}
},
"required": [
"identifier"
],
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"Scriptlets": {
"additionalProperties": false,
"properties": {
"post-deinstall": {
"description": "Optional: The script to run after uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"post-install": {
"description": "Optional: The script to run post install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"post-upgrade": {
"description": "Optional: The script to run after upgrading. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-deinstall": {
"description": "Optional: The script to run before uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"pre-install": {
"description": "Optional: The script to run pre install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-upgrade": {
"description": "Optional: The script to run before upgrading. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"trigger": {
"$ref": "#/$defs/Trigger",
"description": "Optional: A script to run on a custom trigger"
}
},
"type": "object"
},
"Subpackage": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the subpackage build configuration",
"type": "string"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "Optional: List of packages to depend on"
},
"description": {
"description": "Optional: The human readable description of the subpackage",
"type": "string"
},
"if": {
"description": "Optional: A conditional statement to evaluate for the subpackage",
"type": "string"
},
"name": {
"description": "Required: Name of the subpackage",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"pipeline": {
"description": "Optional: The list of pipelines that produce subpackage.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"range": {
"description": "Optional: The iterable used to generate multiple subpackages",
"type": "string"
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets"
},
"test": {
"$ref": "#/$defs/Test",
"description": "Test section for the subpackage."
},
"url": {
"description": "Optional: The URL to the package's homepage",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Test": {
"additionalProperties": false,
"properties": {
"environment": {
"$ref": "#/$defs/ImageConfiguration",
"description": "Additional Environment necessary for test.\nEnvironment.Contents.Packages automatically get\npackage.dependencies.runtime added to it. So, if your test needs\nno additional packages, you can leave it blank."
},
"pipeline": {
"description": "Required: The list of pipelines that test the produced package.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
}
},
"required": [
"environment",
"pipeline"
],
"type": "object"
},
"Trigger": {
"additionalProperties": false,
"properties": {
"paths": {
"description": "Optional: The list of paths to monitor to trigger the script",
"items": {
"type": "string"
},
"type": "array"
},
"script": {
"description": "Optional: The script to run",
"type": "string"
}
},
"type": "object"
},
"Update": {
"additionalProperties": false,
"description": "Update provides information used to describe how to keep the package up to date",
"properties": {
"enabled": {
"description": "Toggle if updates should occur",
"type": "boolean"
},
"github": {
"$ref": "#/$defs/GitHubMonitor",
"description": "The configuration block for updates tracked via the Github API"
},
"ignore-regex-patterns": {
"description": "A slice of regex patterns to match an upstream version and ignore",
"items": {
"type": "string"
},
"type": "array"
},
"manual": {
"description": "Indicates that this package should be manually updated, usually taking\ncare over special version numbers",
"type": "boolean"
},
"release-monitor": {
"$ref": "#/$defs/ReleaseMonitor",
"description": "The configuration block for updates tracked via release-monitoring.org"
},
"shared": {
"description": "Indicate that an update to this package requires an epoch bump of\ndownstream dependencies, e.g. golang, java",
"type": "boolean"
},
"version-separator": {
"description": "Override the version separator if it is nonstandard",
"type": "string"
},
"version-transform": {
"description": "The configuration block for transforming the `package.version` into an APK version",
"items": {
"$ref": "#/$defs/VersionTransform"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"User": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"shell": {
"type": "string"
},
"uid": {
"type": "integer"
},
"username": {
"type": "string"
}
},
"type": "object"
},
"VarTransforms": {
"additionalProperties": false,
"properties": {
"from": {
"description": "Required: The original template variable.\n\nExample: ${{package.version}}",
"type": "string"
},
"match": {
"description": "Required: The regular expression to match against the `from` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
},
"to": {
"description": "Required: The name of the new variable to create\n\nExample: mangeled-package-version",
"type": "string"
}
},
"required": [
"from",
"match",
"replace",
"to"
],
"type": "object"
},
"VersionTransform": {
"additionalProperties": false,
"description": "VersionTransform allows mapping the package version to an APK version",
"properties": {
"match": {
"description": "Required: The regular expression to match against the `package.version` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
}
},
"required": [
"match",
"replace"
],
"type": "object"
}
},
"$id": "https://chainguard.dev/melange/pkg/config/configuration",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
chainguard-dev/melange | 6d6fdc0225094a4a86a9e0cd7346c1f3e70af8bb | 2024-01-16T20:39:30 | pkg/config/schema.json | 367 | 2024-05-27T05:33:19.976056Z | {
"$defs": {
"BuildOption": {
"additionalProperties": false,
"description": "BuildOption describes an optional deviation to a package build.",
"properties": {
"Environment": {
"$ref": "#/$defs/EnvironmentOption"
},
"Vars": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"required": [
"Vars",
"Environment"
],
"type": "object"
},
"Checks": {
"additionalProperties": false,
"properties": {
"disabled": {
"description": "Optional: disable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Optional: enable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "The root melange configuration",
"properties": {
"data": {
"description": "Optional: An arbitrary list of data that can be used via templating in the\npipeline",
"items": {
"$ref": "#/$defs/RangeData"
},
"type": "array"
},
"environment": {
"$ref": "#/$defs/ImageConfiguration",
"description": "The specification for the packages build environment"
},
"options": {
"additionalProperties": {
"$ref": "#/$defs/BuildOption"
},
"description": "Optional: Deviations to the build",
"type": "object"
},
"package": {
"$ref": "#/$defs/Package",
"description": "Package metadata"
},
"pipeline": {
"description": "Required: The list of pipelines that produce the package.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"subpackages": {
"description": "Optional: The list of subpackages that this package also produces.",
"items": {
"$ref": "#/$defs/Subpackage"
},
"type": "array"
},
"test": {
"$ref": "#/$defs/Test",
"description": "Test section for the main package."
},
"update": {
"$ref": "#/$defs/Update",
"description": "Optional: The update block determining how this package is auto updated"
},
"var-transforms": {
"description": "Optional: A list of transformations to create for the builtin template\nvariables",
"items": {
"$ref": "#/$defs/VarTransforms"
},
"type": "array"
},
"vars": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: A map of arbitrary variables that can be used via templating in\nthe pipeline",
"type": "object"
}
},
"required": [
"package",
"environment"
],
"type": "object"
},
"ContentsOption": {
"additionalProperties": false,
"description": "ContentsOption describes an optional deviation to an apko environment's contents block.",
"properties": {
"Packages": {
"$ref": "#/$defs/ListOption"
}
},
"required": [
"Packages"
],
"type": "object"
},
"Copyright": {
"additionalProperties": false,
"properties": {
"attestation": {
"description": "Optional: Attestations of the license",
"type": "string"
},
"license": {
"description": "Required: The license for this package",
"type": "string"
},
"paths": {
"description": "Optional: The license paths, typically '*'",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"license"
],
"type": "object"
},
"DataItems": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Dependencies": {
"additionalProperties": false,
"properties": {
"provider-priority": {
"description": "Optional: An integer compared against other equal package provides used to\ndetermine priority",
"type": "integer"
},
"provides": {
"description": "Optional: List of packages provided",
"items": {
"type": "string"
},
"type": "array"
},
"replaces": {
"description": "Optional: List of replace objectives",
"items": {
"type": "string"
},
"type": "array"
},
"runtime": {
"description": "Optional: List of runtime dependencies",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"EnvironmentOption": {
"additionalProperties": false,
"description": "EnvironmentOption describes an optional deviation to an apko environment.",
"properties": {
"Contents": {
"$ref": "#/$defs/ContentsOption"
}
},
"required": [
"Contents"
],
"type": "object"
},
"GitHubMonitor": {
"additionalProperties": false,
"description": "GitHubMonitor indicates using the GitHub API",
"properties": {
"identifier": {
"description": "Org/repo for GitHub",
"type": "string"
},
"strip-prefix": {
"description": "If the version in GitHub contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in GitHub contains a suffix which should be ignored",
"type": "string"
},
"tag-filter": {
"description": "Filter to apply when searching tags on a GitHub repository\nDeprecated: Use TagFilterPrefix instead",
"type": "string"
},
"tag-filter-contains": {
"description": "Filter to apply when searching tags on a GitHub repository",
"type": "string"
},
"tag-filter-prefix": {
"description": "Prefix filter to apply when searching tags on a GitHub repository",
"type": "string"
},
"use-tag": {
"description": "Override the default of using a GitHub release to identify related tag to\nfetch. Not all projects use GitHub releases but just use tags",
"type": "boolean"
}
},
"required": [
"identifier"
],
"type": "object"
},
"Group": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"groupname": {
"type": "string"
},
"members": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageAccounts": {
"additionalProperties": false,
"properties": {
"groups": {
"items": {
"$ref": "#/$defs/Group"
},
"type": "array"
},
"run-as": {
"type": "string"
},
"users": {
"items": {
"$ref": "#/$defs/User"
},
"type": "array"
}
},
"type": "object"
},
"ImageConfiguration": {
"additionalProperties": false,
"properties": {
"accounts": {
"$ref": "#/$defs/ImageAccounts"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"archs": {
"items": {
"type": "string"
},
"type": "array"
},
"cmd": {
"type": "string"
},
"contents": {
"$ref": "#/$defs/ImageContents"
},
"entrypoint": {
"$ref": "#/$defs/ImageEntrypoint"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"include": {
"type": "string"
},
"os-release": {
"$ref": "#/$defs/OSRelease"
},
"paths": {
"items": {
"$ref": "#/$defs/PathMutation"
},
"type": "array"
},
"stop-signal": {
"type": "string"
},
"vcs-url": {
"type": "string"
},
"volumes": {
"items": {
"type": "string"
},
"type": "array"
},
"work-dir": {
"type": "string"
}
},
"type": "object"
},
"ImageContents": {
"additionalProperties": false,
"properties": {
"keyring": {
"items": {
"type": "string"
},
"type": "array"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"repositories": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageEntrypoint": {
"additionalProperties": false,
"properties": {
"command": {
"type": "string"
},
"services": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"shell-fragment": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"Input": {
"additionalProperties": false,
"properties": {
"default": {
"description": "Optional: The default value of the input. Required when the input is.",
"type": "string"
},
"description": {
"description": "Optional: The human readable description of the input",
"type": "string"
},
"required": {
"description": "Optional: A toggle denoting whether the input is required or not",
"type": "boolean"
}
},
"type": "object"
},
"ListOption": {
"additionalProperties": false,
"description": "ListOption describes an optional deviation to a list, for example, a list of packages.",
"properties": {
"Add": {
"items": {
"type": "string"
},
"type": "array"
},
"Remove": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Add",
"Remove"
],
"type": "object"
},
"Needs": {
"additionalProperties": false,
"properties": {
"Packages": {
"description": "A list of packages needed by this pipeline",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Packages"
],
"type": "object"
},
"OSRelease": {
"additionalProperties": false,
"properties": {
"bug-report-url": {
"type": "string"
},
"home-url": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"pretty-name": {
"type": "string"
},
"version-id": {
"type": "string"
}
},
"type": "object"
},
"Package": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the package build configuration",
"type": "string"
},
"copyright": {
"description": "The list of copyrights for this package",
"items": {
"$ref": "#/$defs/Copyright"
},
"type": "array"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "List of packages to depends on"
},
"description": {
"description": "A human readable description of the package",
"type": "string"
},
"epoch": {
"description": "The monotone increasing epoch of the package",
"type": "integer"
},
"name": {
"description": "The name of the package",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Optional: Resources to allocate to the build."
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets",
"description": "Optional: Executable scripts that run at various stages of the package\nlifecycle, triggered by configurable events"
},
"target-architecture": {
"description": "List of target architectures for which this package should be build for",
"items": {
"type": "string"
},
"type": "array"
},
"timeout": {
"description": "Optional: The amount of time to allow this build to take before timing out.",
"type": "integer"
},
"url": {
"description": "The URL to the package's homepage",
"type": "string"
},
"version": {
"description": "The version of the package",
"type": "string"
}
},
"required": [
"name",
"version",
"epoch"
],
"type": "object"
},
"PackageOption": {
"additionalProperties": false,
"properties": {
"no-commands": {
"description": "Optional: Mark this package as not providing any executables",
"type": "boolean"
},
"no-depends": {
"description": "Optional: Mark this package as a self contained package that does not\ndepend on any other package",
"type": "boolean"
},
"no-provides": {
"description": "Optional: Signify this package as a virtual package which does not provide\nany files, executables, libraries, etc... and is otherwise empty",
"type": "boolean"
}
},
"required": [
"no-provides",
"no-depends",
"no-commands"
],
"type": "object"
},
"PathMutation": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
},
"recursive": {
"type": "boolean"
},
"source": {
"type": "string"
},
"type": {
"type": "string"
},
"uid": {
"type": "integer"
}
},
"type": "object"
},
"Pipeline": {
"additionalProperties": false,
"properties": {
"assertions": {
"$ref": "#/$defs/PipelineAssertions",
"description": "Optional: Assertions to evaluate whether the pipeline was successful"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: environment variables to override the apko environment",
"type": "object"
},
"if": {
"description": "Optional: A condition to evaluate before running the pipeline",
"type": "string"
},
"inputs": {
"additionalProperties": {
"$ref": "#/$defs/Input"
},
"description": "Optional: A map of inputs to the pipeline",
"type": "object"
},
"label": {
"description": "Optional: Labels to apply to the pipeline",
"type": "string"
},
"name": {
"description": "Optional: A user defined name for the pipeline",
"type": "string"
},
"needs": {
"$ref": "#/$defs/Needs",
"description": "Optional: Configuration to determine any explicit dependencies this pipeline may have"
},
"pipeline": {
"description": "Optional: The list of pipelines to run.\n\nEach pipeline runs in it's own context that is not shared between other\npipelines. To share context between pipelines, nest a pipeline within an\nexisting pipeline. This can be useful when you wish to share common\nconfiguration, such as an alternative `working-directory`.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"runs": {
"description": "Optional: The command to run using the builder's shell (/bin/sh)",
"type": "string"
},
"uses": {
"description": "Optional: A named reusable pipeline to run\n\nThis can be either a pipeline builtin to melange, or a user defined named pipeline.\nFor example, to use a builtin melange pipeline:\n\t\tuses: autoconf/make",
"type": "string"
},
"with": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Arguments passed to the reusable pipelines defined in `uses`",
"type": "object"
},
"working-directory": {
"description": "Optional: The working directory of the pipeline\n\nThis defaults to the guests' build workspace (/home/build)",
"type": "string"
}
},
"type": "object"
},
"PipelineAssertions": {
"additionalProperties": false,
"properties": {
"required-steps": {
"description": "The number (an int) of required steps that must complete successfully\nwithin the asserted pipeline.",
"type": "integer"
}
},
"type": "object"
},
"RangeData": {
"additionalProperties": false,
"properties": {
"items": {
"$ref": "#/$defs/DataItems"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"items"
],
"type": "object"
},
"ReleaseMonitor": {
"additionalProperties": false,
"description": "ReleaseMonitor indicates using the API for https://release-monitoring.org/",
"properties": {
"identifier": {
"description": "Required: ID number for release monitor",
"type": "integer"
},
"strip-prefix": {
"description": "If the version in release monitor contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in release monitor contains a suffix which should be ignored",
"type": "string"
}
},
"required": [
"identifier"
],
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"Scriptlets": {
"additionalProperties": false,
"properties": {
"post-deinstall": {
"description": "Optional: The script to run after uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"post-install": {
"description": "Optional: The script to run post install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"post-upgrade": {
"description": "Optional: The script to run after upgrading. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-deinstall": {
"description": "Optional: The script to run before uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"pre-install": {
"description": "Optional: The script to run pre install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-upgrade": {
"description": "Optional: The script to run before upgrading. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"trigger": {
"additionalProperties": false,
"description": "Optional: A script to run on a custom trigger",
"properties": {
"paths": {
"items": {
"type": "string"
},
"type": "array"
},
"script": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"Subpackage": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the subpackage build configuration",
"type": "string"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "Optional: List of packages to depend on"
},
"description": {
"description": "Optional: The human readable description of the subpackage",
"type": "string"
},
"if": {
"description": "Optional: A conditional statement to evaluate for the subpackage",
"type": "string"
},
"name": {
"description": "Required: Name of the subpackage",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"pipeline": {
"description": "Optional: The list of pipelines that produce subpackage.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"range": {
"description": "Optional: The iterable used to generate multiple subpackages",
"type": "string"
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets"
},
"test": {
"$ref": "#/$defs/Test",
"description": "Test section for the subpackage."
},
"url": {
"description": "Optional: The URL to the package's homepage",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Test": {
"additionalProperties": false,
"properties": {
"Environment": {
"$ref": "#/$defs/ImageConfiguration",
"description": "Additional Environment necessary for test.\nEnvironment.Contents.Packages automatically get\npackage.dependencies.runtime added to it. So, if your test needs\nno additional packages, you can leave it blank."
},
"pipeline": {
"description": "Required: The list of pipelines that test the produced package.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
}
},
"required": [
"Environment",
"pipeline"
],
"type": "object"
},
"Update": {
"additionalProperties": false,
"description": "Update provides information used to describe how to keep the package up to date",
"properties": {
"enabled": {
"description": "Toggle if updates should occur",
"type": "boolean"
},
"github": {
"$ref": "#/$defs/GitHubMonitor",
"description": "The configuration block for updates tracked via the Github API"
},
"ignore-regex-patterns": {
"description": "A slice of regex patterns to match an upstream version and ignore",
"items": {
"type": "string"
},
"type": "array"
},
"manual": {
"description": "Indicates that this package should be manually updated, usually taking\ncare over special version numbers",
"type": "boolean"
},
"release-monitor": {
"$ref": "#/$defs/ReleaseMonitor",
"description": "The configuration block for updates tracked via release-monitoring.org"
},
"shared": {
"description": "Indicate that an update to this package requires an epoch bump of\ndownstream dependencies, e.g. golang, java",
"type": "boolean"
},
"version-separator": {
"description": "Override the version separator if it is nonstandard",
"type": "string"
},
"version-transform": {
"description": "The configuration block for transforming the `package.version` into an APK version",
"items": {
"$ref": "#/$defs/VersionTransform"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"User": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"uid": {
"type": "integer"
},
"username": {
"type": "string"
}
},
"type": "object"
},
"VarTransforms": {
"additionalProperties": false,
"properties": {
"from": {
"description": "Required: The original template variable.\n\nExample: ${{package.version}}",
"type": "string"
},
"match": {
"description": "Required: The regular expression to match against the `from` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
},
"to": {
"description": "Required: The name of the new variable to create\n\nExample: mangeled-package-version",
"type": "string"
}
},
"required": [
"from",
"match",
"replace",
"to"
],
"type": "object"
},
"VersionTransform": {
"additionalProperties": false,
"description": "VersionTransform allows mapping the package version to an APK version",
"properties": {
"match": {
"description": "Required: The regular expression to match against the `package.version` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
}
},
"required": [
"match",
"replace"
],
"type": "object"
}
},
"$id": "https://chainguard.dev/melange/pkg/config/configuration",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
chainguard-dev/melange | 9b0590dd535a6638cf4f99997197352c734a3667 | 2023-11-20T17:46:54 | pkg/config/schema.json | 367 | 2024-05-27T05:33:19.976056Z | {
"$defs": {
"AccountsOption": {
"additionalProperties": false,
"properties": {
"RunAs": {
"type": "string"
}
},
"required": [
"RunAs"
],
"type": "object"
},
"BuildOption": {
"additionalProperties": false,
"properties": {
"Accounts": {
"$ref": "#/$defs/AccountsOption"
},
"Contents": {
"$ref": "#/$defs/ContentsOption"
},
"Entrypoint": {
"$ref": "#/$defs/ImageEntrypoint"
},
"Environment": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"required": [
"Contents",
"Accounts",
"Environment",
"Entrypoint"
],
"type": "object"
},
"Checks": {
"additionalProperties": false,
"properties": {
"disabled": {
"description": "Optional: disable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Optional: enable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "The root melange configuration",
"properties": {
"data": {
"description": "Optional: An arbitrary list of data that can be used via templating in the\npipeline",
"items": {
"$ref": "#/$defs/RangeData"
},
"type": "array"
},
"environment": {
"$ref": "#/$defs/ImageConfiguration",
"description": "The specification for the packages build environment"
},
"options": {
"additionalProperties": {
"$ref": "#/$defs/BuildOption"
},
"description": "Optional: Deviations to the build",
"type": "object"
},
"package": {
"$ref": "#/$defs/Package",
"description": "Package metadata"
},
"pipeline": {
"description": "Required: The list of pipelines that produce the package.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"subpackages": {
"description": "Optional: The list of subpackages that this package also produces.",
"items": {
"$ref": "#/$defs/Subpackage"
},
"type": "array"
},
"update": {
"$ref": "#/$defs/Update",
"description": "Optional: The update block determining how this package is auto updated"
},
"var-transforms": {
"description": "Optional: A list of transformations to create for the builtin template\nvariables",
"items": {
"$ref": "#/$defs/VarTransforms"
},
"type": "array"
},
"vars": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: A map of arbitrary variables that can be used via templating in\nthe pipeline",
"type": "object"
}
},
"required": [
"package",
"environment"
],
"type": "object"
},
"ContentsOption": {
"additionalProperties": false,
"properties": {
"Packages": {
"$ref": "#/$defs/ListOption"
}
},
"required": [
"Packages"
],
"type": "object"
},
"Copyright": {
"additionalProperties": false,
"properties": {
"attestation": {
"description": "Optional: Attestations of the license",
"type": "string"
},
"license": {
"description": "Required: The license for this package",
"type": "string"
},
"paths": {
"description": "Optional: The license paths, typically '*'",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"license"
],
"type": "object"
},
"DataItems": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Dependencies": {
"additionalProperties": false,
"properties": {
"provider-priority": {
"description": "Optional: An integer compared against other equal package provides used to\ndetermine priority",
"type": "integer"
},
"provides": {
"description": "Optional: List of packages provided",
"items": {
"type": "string"
},
"type": "array"
},
"replaces": {
"description": "Optional: List of replace objectives",
"items": {
"type": "string"
},
"type": "array"
},
"runtime": {
"description": "Optional: List of runtime dependencies",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GitHubMonitor": {
"additionalProperties": false,
"description": "GitHubMonitor indicates using the GitHub API",
"properties": {
"identifier": {
"description": "Org/repo for GitHub",
"type": "string"
},
"strip-prefix": {
"description": "If the version in GitHub contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in GitHub contains a suffix which should be ignored",
"type": "string"
},
"tag-filter": {
"description": "Filter to apply when searching tags on a GitHub repository",
"type": "string"
},
"use-tag": {
"description": "Override the default of using a GitHub release to identify related tag to\nfetch. Not all projects use GitHub releases but just use tags",
"type": "boolean"
}
},
"required": [
"identifier"
],
"type": "object"
},
"Group": {
"additionalProperties": false,
"properties": {
"GID": {
"type": "integer"
},
"GroupName": {
"type": "string"
},
"Members": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"GroupName",
"GID",
"Members"
],
"type": "object"
},
"ImageAccounts": {
"additionalProperties": false,
"properties": {
"Groups": {
"items": {
"$ref": "#/$defs/Group"
},
"type": "array"
},
"RunAs": {
"type": "string"
},
"Users": {
"items": {
"$ref": "#/$defs/User"
},
"type": "array"
}
},
"required": [
"RunAs",
"Users",
"Groups"
],
"type": "object"
},
"ImageConfiguration": {
"additionalProperties": false,
"properties": {
"Accounts": {
"$ref": "#/$defs/ImageAccounts"
},
"Annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Archs": {
"items": {
"type": "string"
},
"type": "array"
},
"Cmd": {
"type": "string"
},
"Contents": {
"$ref": "#/$defs/ImageContents"
},
"Entrypoint": {
"$ref": "#/$defs/ImageEntrypoint"
},
"Environment": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Include": {
"type": "string"
},
"OSRelease": {
"$ref": "#/$defs/OSRelease"
},
"Options": {
"additionalProperties": {
"$ref": "#/$defs/BuildOption"
},
"type": "object"
},
"Paths": {
"items": {
"$ref": "#/$defs/PathMutation"
},
"type": "array"
},
"StopSignal": {
"type": "string"
},
"VCSUrl": {
"type": "string"
},
"Volumes": {
"items": {
"type": "string"
},
"type": "array"
},
"WorkDir": {
"type": "string"
}
},
"required": [
"Contents",
"Entrypoint",
"Cmd",
"StopSignal",
"WorkDir",
"Accounts",
"Archs",
"Environment",
"Paths",
"OSRelease",
"VCSUrl",
"Annotations",
"Include",
"Options",
"Volumes"
],
"type": "object"
},
"ImageContents": {
"additionalProperties": false,
"properties": {
"Keyring": {
"items": {
"type": "string"
},
"type": "array"
},
"Packages": {
"items": {
"type": "string"
},
"type": "array"
},
"Repositories": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Repositories",
"Keyring",
"Packages"
],
"type": "object"
},
"ImageEntrypoint": {
"additionalProperties": false,
"properties": {
"Command": {
"type": "string"
},
"Services": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"ShellFragment": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"required": [
"Type",
"Command",
"ShellFragment",
"Services"
],
"type": "object"
},
"Input": {
"additionalProperties": false,
"properties": {
"default": {
"description": "Optional: The default value of the input. Required when the input is.",
"type": "string"
},
"description": {
"description": "Optional: The human readable description of the input",
"type": "string"
},
"required": {
"description": "Optional: A toggle denoting whether the input is required or not",
"type": "boolean"
}
},
"type": "object"
},
"ListOption": {
"additionalProperties": false,
"properties": {
"Add": {
"items": {
"type": "string"
},
"type": "array"
},
"Remove": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Add",
"Remove"
],
"type": "object"
},
"Needs": {
"additionalProperties": false,
"properties": {
"Packages": {
"description": "A list of packages needed by this pipeline",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Packages"
],
"type": "object"
},
"OSRelease": {
"additionalProperties": false,
"properties": {
"BugReportURL": {
"type": "string"
},
"HomeURL": {
"type": "string"
},
"ID": {
"type": "string"
},
"Name": {
"type": "string"
},
"PrettyName": {
"type": "string"
},
"VersionID": {
"type": "string"
}
},
"required": [
"Name",
"ID",
"VersionID",
"PrettyName",
"HomeURL",
"BugReportURL"
],
"type": "object"
},
"Package": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the package build configuration",
"type": "string"
},
"copyright": {
"description": "The list of copyrights for this package",
"items": {
"$ref": "#/$defs/Copyright"
},
"type": "array"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "List of packages to depends on"
},
"description": {
"description": "A human readable description of the package",
"type": "string"
},
"epoch": {
"description": "The monotone increasing epoch of the package",
"type": "integer"
},
"name": {
"description": "The name of the package",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets",
"description": "Optional: Executable scripts that run at various stages of the package\nlifecycle, triggered by configurable events"
},
"target-architecture": {
"description": "List of target architectures for which this package should be build for",
"items": {
"type": "string"
},
"type": "array"
},
"url": {
"description": "The URL to the package's homepage",
"type": "string"
},
"version": {
"description": "The version of the package",
"type": "string"
}
},
"required": [
"name",
"version",
"epoch"
],
"type": "object"
},
"PackageOption": {
"additionalProperties": false,
"properties": {
"no-commands": {
"description": "Optional: Mark this package as not providing any executables",
"type": "boolean"
},
"no-depends": {
"description": "Optional: Mark this package as a self contained package that does not\ndepend on any other package",
"type": "boolean"
},
"no-provides": {
"description": "Optional: Signify this package as a virtual package which does not provide\nany files, executables, libraries, etc... and is otherwise empty",
"type": "boolean"
}
},
"required": [
"no-provides",
"no-depends",
"no-commands"
],
"type": "object"
},
"PathMutation": {
"additionalProperties": false,
"properties": {
"GID": {
"type": "integer"
},
"Path": {
"type": "string"
},
"Permissions": {
"type": "integer"
},
"Recursive": {
"type": "boolean"
},
"Source": {
"type": "string"
},
"Type": {
"type": "string"
},
"UID": {
"type": "integer"
}
},
"required": [
"Path",
"Type",
"UID",
"GID",
"Permissions",
"Source",
"Recursive"
],
"type": "object"
},
"Pipeline": {
"additionalProperties": false,
"properties": {
"assertions": {
"$ref": "#/$defs/PipelineAssertions",
"description": "Optional: Assertions to evaluate whether the pipeline was successful"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: environment variables to override the apko environment",
"type": "object"
},
"if": {
"description": "Optional: A condition to evaluate before running the pipeline",
"type": "string"
},
"inputs": {
"additionalProperties": {
"$ref": "#/$defs/Input"
},
"description": "Optional: A map of inputs to the pipeline",
"type": "object"
},
"label": {
"description": "Optional: Labels to apply to the pipeline",
"type": "string"
},
"name": {
"description": "Optional: A user defined name for the pipeline",
"type": "string"
},
"needs": {
"$ref": "#/$defs/Needs",
"description": "Optional: Configuration to determine any explicit dependencies this pipeline may have"
},
"pipeline": {
"description": "Optional: The list of pipelines to run.\n\nEach pipeline runs in it's own context that is not shared between other\npipelines. To share context between pipelines, nest a pipeline within an\nexisting pipeline. This can be useful when you wish to share common\nconfiguration, such as an alternative `working-directory`.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"runs": {
"description": "Optional: The command to run using the builder's shell (/bin/sh)",
"type": "string"
},
"sbom": {
"$ref": "#/$defs/SBOM",
"description": "Optional: Configuration for the generated SBOM"
},
"uses": {
"description": "Optional: A named reusable pipeline to run\n\nThis can be either a pipeline builtin to melange, or a user defined named pipeline.\nFor example, to use a builtin melange pipeline:\n\t\tuses: autoconf/make",
"type": "string"
},
"with": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Arguments passed to the reusable pipelines defined in `uses`",
"type": "object"
},
"working-directory": {
"description": "Optional: The working directory of the pipeline\n\nThis defaults to the guests' build workspace (/home/build)",
"type": "string"
}
},
"type": "object"
},
"PipelineAssertions": {
"additionalProperties": false,
"properties": {
"required-steps": {
"description": "The number (an int) of required steps that must complete successfully\nwithin the asserted pipeline.",
"type": "integer"
}
},
"type": "object"
},
"RangeData": {
"additionalProperties": false,
"properties": {
"items": {
"$ref": "#/$defs/DataItems"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"items"
],
"type": "object"
},
"ReleaseMonitor": {
"additionalProperties": false,
"description": "ReleaseMonitor indicates using the API for https://release-monitoring.org/",
"properties": {
"identifier": {
"description": "Required: ID number for release monitor",
"type": "integer"
},
"strip-prefix": {
"description": "If the version in release monitor contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in release monitor contains a suffix which should be ignored",
"type": "string"
}
},
"required": [
"identifier"
],
"type": "object"
},
"SBOM": {
"additionalProperties": false,
"properties": {
"language": {
"description": "Optional: The language of the generated SBOM",
"type": "string"
}
},
"required": [
"language"
],
"type": "object"
},
"Scriptlets": {
"additionalProperties": false,
"properties": {
"post-deinstall": {
"description": "Optional: The script to run after uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"post-install": {
"description": "Optional: The script to run post install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"post-upgrade": {
"description": "Optional: The script to run after upgrading. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-deinstall": {
"description": "Optional: The script to run before uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"pre-install": {
"description": "Optional: The script to run pre install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-upgrade": {
"description": "Optional: The script to run before upgrading. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"trigger": {
"additionalProperties": false,
"description": "Optional: A script to run on a custom trigger",
"properties": {
"paths": {
"items": {
"type": "string"
},
"type": "array"
},
"script": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"Subpackage": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the subpackage build configuration",
"type": "string"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "Optional: List of packages to depend on"
},
"description": {
"description": "Optional: The human readable description of the subpackage",
"type": "string"
},
"if": {
"description": "Optional: A conditional statement to evaluate for the subpackage",
"type": "string"
},
"name": {
"description": "Required: Name of the subpackage",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"pipeline": {
"description": "Optional: The list of pipelines that produce subpackage.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"range": {
"description": "Optional: The iterable used to generate multiple subpackages",
"type": "string"
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets"
},
"url": {
"description": "Optional: The URL to the package's homepage",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Update": {
"additionalProperties": false,
"description": "Update provides information used to describe how to keep the package up to date",
"properties": {
"enabled": {
"description": "Toggle if updates should occur",
"type": "boolean"
},
"github": {
"$ref": "#/$defs/GitHubMonitor",
"description": "The configuration block for updates tracked via the Github API"
},
"ignore-regex-patterns": {
"description": "A slice of regex patterns to match an upstream version and ignore",
"items": {
"type": "string"
},
"type": "array"
},
"manual": {
"description": "Indicates that this package should be manually updated, usually taking\ncare over special version numbers",
"type": "boolean"
},
"release-monitor": {
"$ref": "#/$defs/ReleaseMonitor",
"description": "The configuration block for updates tracked via release-monitoring.org"
},
"shared": {
"description": "Indicate that an update to this package requires an epoch bump of\ndownstream dependencies, e.g. golang, java",
"type": "boolean"
},
"version-separator": {
"description": "Override the version separator if it is nonstandard",
"type": "string"
},
"version-transform": {
"description": "The configuration block for transforming the `package.version` into an APK version",
"items": {
"$ref": "#/$defs/VersionTransform"
},
"type": "array"
}
},
"required": [
"enabled",
"manual"
],
"type": "object"
},
"User": {
"additionalProperties": false,
"properties": {
"GID": {
"type": "integer"
},
"UID": {
"type": "integer"
},
"UserName": {
"type": "string"
}
},
"required": [
"UserName",
"UID",
"GID"
],
"type": "object"
},
"VarTransforms": {
"additionalProperties": false,
"properties": {
"from": {
"description": "Required: The original template variable.\n\nExample: ${{package.version}}",
"type": "string"
},
"match": {
"description": "Required: The regular expression to match against the `from` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
},
"to": {
"description": "Required: The name of the new variable to create\n\nExample: mangeled-package-version",
"type": "string"
}
},
"required": [
"from",
"match",
"replace",
"to"
],
"type": "object"
},
"VersionTransform": {
"additionalProperties": false,
"description": "VersionTransform allows mapping the package version to an APK version",
"properties": {
"match": {
"description": "Required: The regular expression to match against the `package.version` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
}
},
"required": [
"match",
"replace"
],
"type": "object"
}
},
"$id": "https://chainguard.dev/melange/pkg/config/configuration",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
chainguard-dev/melange | 2aeed52f54d74a09a3e7715137cf7268986b287e | 2023-12-05T00:09:48 | pkg/config/schema.json | 367 | 2024-05-27T05:33:19.976056Z | {
"$defs": {
"AccountsOption": {
"additionalProperties": false,
"properties": {
"RunAs": {
"type": "string"
}
},
"required": [
"RunAs"
],
"type": "object"
},
"BuildOption": {
"additionalProperties": false,
"properties": {
"Accounts": {
"$ref": "#/$defs/AccountsOption"
},
"Contents": {
"$ref": "#/$defs/ContentsOption"
},
"Entrypoint": {
"$ref": "#/$defs/ImageEntrypoint"
},
"Environment": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"required": [
"Contents",
"Accounts",
"Environment",
"Entrypoint"
],
"type": "object"
},
"Checks": {
"additionalProperties": false,
"properties": {
"disabled": {
"description": "Optional: disable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Optional: enable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "The root melange configuration",
"properties": {
"data": {
"description": "Optional: An arbitrary list of data that can be used via templating in the\npipeline",
"items": {
"$ref": "#/$defs/RangeData"
},
"type": "array"
},
"environment": {
"$ref": "#/$defs/ImageConfiguration",
"description": "The specification for the packages build environment"
},
"options": {
"additionalProperties": {
"$ref": "#/$defs/BuildOption"
},
"description": "Optional: Deviations to the build",
"type": "object"
},
"package": {
"$ref": "#/$defs/Package",
"description": "Package metadata"
},
"pipeline": {
"description": "Required: The list of pipelines that produce the package.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"subpackages": {
"description": "Optional: The list of subpackages that this package also produces.",
"items": {
"$ref": "#/$defs/Subpackage"
},
"type": "array"
},
"update": {
"$ref": "#/$defs/Update",
"description": "Optional: The update block determining how this package is auto updated"
},
"var-transforms": {
"description": "Optional: A list of transformations to create for the builtin template\nvariables",
"items": {
"$ref": "#/$defs/VarTransforms"
},
"type": "array"
},
"vars": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: A map of arbitrary variables that can be used via templating in\nthe pipeline",
"type": "object"
}
},
"required": [
"package",
"environment"
],
"type": "object"
},
"ContentsOption": {
"additionalProperties": false,
"properties": {
"Packages": {
"$ref": "#/$defs/ListOption"
}
},
"required": [
"Packages"
],
"type": "object"
},
"Copyright": {
"additionalProperties": false,
"properties": {
"attestation": {
"description": "Optional: Attestations of the license",
"type": "string"
},
"license": {
"description": "Required: The license for this package",
"type": "string"
},
"paths": {
"description": "Optional: The license paths, typically '*'",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"license"
],
"type": "object"
},
"DataItems": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Dependencies": {
"additionalProperties": false,
"properties": {
"provider-priority": {
"description": "Optional: An integer compared against other equal package provides used to\ndetermine priority",
"type": "integer"
},
"provides": {
"description": "Optional: List of packages provided",
"items": {
"type": "string"
},
"type": "array"
},
"replaces": {
"description": "Optional: List of replace objectives",
"items": {
"type": "string"
},
"type": "array"
},
"runtime": {
"description": "Optional: List of runtime dependencies",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GitHubMonitor": {
"additionalProperties": false,
"description": "GitHubMonitor indicates using the GitHub API",
"properties": {
"identifier": {
"description": "Org/repo for GitHub",
"type": "string"
},
"strip-prefix": {
"description": "If the version in GitHub contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in GitHub contains a suffix which should be ignored",
"type": "string"
},
"tag-filter": {
"description": "Filter to apply when searching tags on a GitHub repository",
"type": "string"
},
"use-tag": {
"description": "Override the default of using a GitHub release to identify related tag to\nfetch. Not all projects use GitHub releases but just use tags",
"type": "boolean"
}
},
"required": [
"identifier"
],
"type": "object"
},
"Group": {
"additionalProperties": false,
"properties": {
"GID": {
"type": "integer"
},
"GroupName": {
"type": "string"
},
"Members": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"GroupName",
"GID",
"Members"
],
"type": "object"
},
"ImageAccounts": {
"additionalProperties": false,
"properties": {
"Groups": {
"items": {
"$ref": "#/$defs/Group"
},
"type": "array"
},
"RunAs": {
"type": "string"
},
"Users": {
"items": {
"$ref": "#/$defs/User"
},
"type": "array"
}
},
"required": [
"RunAs",
"Users",
"Groups"
],
"type": "object"
},
"ImageConfiguration": {
"additionalProperties": false,
"properties": {
"Accounts": {
"$ref": "#/$defs/ImageAccounts"
},
"Annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Archs": {
"items": {
"type": "string"
},
"type": "array"
},
"Cmd": {
"type": "string"
},
"Contents": {
"$ref": "#/$defs/ImageContents"
},
"Entrypoint": {
"$ref": "#/$defs/ImageEntrypoint"
},
"Environment": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Include": {
"type": "string"
},
"OSRelease": {
"$ref": "#/$defs/OSRelease"
},
"Options": {
"additionalProperties": {
"$ref": "#/$defs/BuildOption"
},
"type": "object"
},
"Paths": {
"items": {
"$ref": "#/$defs/PathMutation"
},
"type": "array"
},
"StopSignal": {
"type": "string"
},
"VCSUrl": {
"type": "string"
},
"Volumes": {
"items": {
"type": "string"
},
"type": "array"
},
"WorkDir": {
"type": "string"
}
},
"required": [
"Contents",
"Entrypoint",
"Cmd",
"StopSignal",
"WorkDir",
"Accounts",
"Archs",
"Environment",
"Paths",
"OSRelease",
"VCSUrl",
"Annotations",
"Include",
"Options",
"Volumes"
],
"type": "object"
},
"ImageContents": {
"additionalProperties": false,
"properties": {
"Keyring": {
"items": {
"type": "string"
},
"type": "array"
},
"Packages": {
"items": {
"type": "string"
},
"type": "array"
},
"Repositories": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Repositories",
"Keyring",
"Packages"
],
"type": "object"
},
"ImageEntrypoint": {
"additionalProperties": false,
"properties": {
"Command": {
"type": "string"
},
"Services": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"ShellFragment": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"required": [
"Type",
"Command",
"ShellFragment",
"Services"
],
"type": "object"
},
"Input": {
"additionalProperties": false,
"properties": {
"default": {
"description": "Optional: The default value of the input. Required when the input is.",
"type": "string"
},
"description": {
"description": "Optional: The human readable description of the input",
"type": "string"
},
"required": {
"description": "Optional: A toggle denoting whether the input is required or not",
"type": "boolean"
}
},
"type": "object"
},
"ListOption": {
"additionalProperties": false,
"properties": {
"Add": {
"items": {
"type": "string"
},
"type": "array"
},
"Remove": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Add",
"Remove"
],
"type": "object"
},
"Needs": {
"additionalProperties": false,
"properties": {
"Packages": {
"description": "A list of packages needed by this pipeline",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Packages"
],
"type": "object"
},
"OSRelease": {
"additionalProperties": false,
"properties": {
"BugReportURL": {
"type": "string"
},
"HomeURL": {
"type": "string"
},
"ID": {
"type": "string"
},
"Name": {
"type": "string"
},
"PrettyName": {
"type": "string"
},
"VersionID": {
"type": "string"
}
},
"required": [
"Name",
"ID",
"VersionID",
"PrettyName",
"HomeURL",
"BugReportURL"
],
"type": "object"
},
"Package": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the package build configuration",
"type": "string"
},
"copyright": {
"description": "The list of copyrights for this package",
"items": {
"$ref": "#/$defs/Copyright"
},
"type": "array"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "List of packages to depends on"
},
"description": {
"description": "A human readable description of the package",
"type": "string"
},
"epoch": {
"description": "The monotone increasing epoch of the package",
"type": "integer"
},
"name": {
"description": "The name of the package",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets",
"description": "Optional: Executable scripts that run at various stages of the package\nlifecycle, triggered by configurable events"
},
"target-architecture": {
"description": "List of target architectures for which this package should be build for",
"items": {
"type": "string"
},
"type": "array"
},
"url": {
"description": "The URL to the package's homepage",
"type": "string"
},
"version": {
"description": "The version of the package",
"type": "string"
}
},
"required": [
"name",
"version",
"epoch"
],
"type": "object"
},
"PackageOption": {
"additionalProperties": false,
"properties": {
"no-commands": {
"description": "Optional: Mark this package as not providing any executables",
"type": "boolean"
},
"no-depends": {
"description": "Optional: Mark this package as a self contained package that does not\ndepend on any other package",
"type": "boolean"
},
"no-provides": {
"description": "Optional: Signify this package as a virtual package which does not provide\nany files, executables, libraries, etc... and is otherwise empty",
"type": "boolean"
}
},
"required": [
"no-provides",
"no-depends",
"no-commands"
],
"type": "object"
},
"PathMutation": {
"additionalProperties": false,
"properties": {
"GID": {
"type": "integer"
},
"Path": {
"type": "string"
},
"Permissions": {
"type": "integer"
},
"Recursive": {
"type": "boolean"
},
"Source": {
"type": "string"
},
"Type": {
"type": "string"
},
"UID": {
"type": "integer"
}
},
"required": [
"Path",
"Type",
"UID",
"GID",
"Permissions",
"Source",
"Recursive"
],
"type": "object"
},
"Pipeline": {
"additionalProperties": false,
"properties": {
"assertions": {
"$ref": "#/$defs/PipelineAssertions",
"description": "Optional: Assertions to evaluate whether the pipeline was successful"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: environment variables to override the apko environment",
"type": "object"
},
"if": {
"description": "Optional: A condition to evaluate before running the pipeline",
"type": "string"
},
"inputs": {
"additionalProperties": {
"$ref": "#/$defs/Input"
},
"description": "Optional: A map of inputs to the pipeline",
"type": "object"
},
"label": {
"description": "Optional: Labels to apply to the pipeline",
"type": "string"
},
"name": {
"description": "Optional: A user defined name for the pipeline",
"type": "string"
},
"needs": {
"$ref": "#/$defs/Needs",
"description": "Optional: Configuration to determine any explicit dependencies this pipeline may have"
},
"pipeline": {
"description": "Optional: The list of pipelines to run.\n\nEach pipeline runs in it's own context that is not shared between other\npipelines. To share context between pipelines, nest a pipeline within an\nexisting pipeline. This can be useful when you wish to share common\nconfiguration, such as an alternative `working-directory`.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"runs": {
"description": "Optional: The command to run using the builder's shell (/bin/sh)",
"type": "string"
},
"sbom": {
"$ref": "#/$defs/SBOM",
"description": "Optional: Configuration for the generated SBOM"
},
"uses": {
"description": "Optional: A named reusable pipeline to run\n\nThis can be either a pipeline builtin to melange, or a user defined named pipeline.\nFor example, to use a builtin melange pipeline:\n\t\tuses: autoconf/make",
"type": "string"
},
"with": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Arguments passed to the reusable pipelines defined in `uses`",
"type": "object"
},
"working-directory": {
"description": "Optional: The working directory of the pipeline\n\nThis defaults to the guests' build workspace (/home/build)",
"type": "string"
}
},
"type": "object"
},
"PipelineAssertions": {
"additionalProperties": false,
"properties": {
"required-steps": {
"description": "The number (an int) of required steps that must complete successfully\nwithin the asserted pipeline.",
"type": "integer"
}
},
"type": "object"
},
"RangeData": {
"additionalProperties": false,
"properties": {
"items": {
"$ref": "#/$defs/DataItems"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"items"
],
"type": "object"
},
"ReleaseMonitor": {
"additionalProperties": false,
"description": "ReleaseMonitor indicates using the API for https://release-monitoring.org/",
"properties": {
"identifier": {
"description": "Required: ID number for release monitor",
"type": "integer"
},
"strip-prefix": {
"description": "If the version in release monitor contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in release monitor contains a suffix which should be ignored",
"type": "string"
}
},
"required": [
"identifier"
],
"type": "object"
},
"SBOM": {
"additionalProperties": false,
"properties": {
"language": {
"description": "Optional: The language of the generated SBOM",
"type": "string"
}
},
"required": [
"language"
],
"type": "object"
},
"Scriptlets": {
"additionalProperties": false,
"properties": {
"post-deinstall": {
"description": "Optional: The script to run after uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"post-install": {
"description": "Optional: The script to run post install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"post-upgrade": {
"description": "Optional: The script to run after upgrading. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-deinstall": {
"description": "Optional: The script to run before uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"pre-install": {
"description": "Optional: The script to run pre install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-upgrade": {
"description": "Optional: The script to run before upgrading. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"trigger": {
"additionalProperties": false,
"description": "Optional: A script to run on a custom trigger",
"properties": {
"paths": {
"items": {
"type": "string"
},
"type": "array"
},
"script": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"Subpackage": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the subpackage build configuration",
"type": "string"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "Optional: List of packages to depend on"
},
"description": {
"description": "Optional: The human readable description of the subpackage",
"type": "string"
},
"if": {
"description": "Optional: A conditional statement to evaluate for the subpackage",
"type": "string"
},
"name": {
"description": "Required: Name of the subpackage",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"pipeline": {
"description": "Optional: The list of pipelines that produce subpackage.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"range": {
"description": "Optional: The iterable used to generate multiple subpackages",
"type": "string"
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets"
},
"url": {
"description": "Optional: The URL to the package's homepage",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Update": {
"additionalProperties": false,
"description": "Update provides information used to describe how to keep the package up to date",
"properties": {
"enabled": {
"description": "Toggle if updates should occur",
"type": "boolean"
},
"github": {
"$ref": "#/$defs/GitHubMonitor",
"description": "The configuration block for updates tracked via the Github API"
},
"ignore-regex-patterns": {
"description": "A slice of regex patterns to match an upstream version and ignore",
"items": {
"type": "string"
},
"type": "array"
},
"manual": {
"description": "Indicates that this package should be manually updated, usually taking\ncare over special version numbers",
"type": "boolean"
},
"release-monitor": {
"$ref": "#/$defs/ReleaseMonitor",
"description": "The configuration block for updates tracked via release-monitoring.org"
},
"shared": {
"description": "Indicate that an update to this package requires an epoch bump of\ndownstream dependencies, e.g. golang, java",
"type": "boolean"
},
"version-separator": {
"description": "Override the version separator if it is nonstandard",
"type": "string"
},
"version-transform": {
"description": "The configuration block for transforming the `package.version` into an APK version",
"items": {
"$ref": "#/$defs/VersionTransform"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"User": {
"additionalProperties": false,
"properties": {
"GID": {
"type": "integer"
},
"UID": {
"type": "integer"
},
"UserName": {
"type": "string"
}
},
"required": [
"UserName",
"UID",
"GID"
],
"type": "object"
},
"VarTransforms": {
"additionalProperties": false,
"properties": {
"from": {
"description": "Required: The original template variable.\n\nExample: ${{package.version}}",
"type": "string"
},
"match": {
"description": "Required: The regular expression to match against the `from` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
},
"to": {
"description": "Required: The name of the new variable to create\n\nExample: mangeled-package-version",
"type": "string"
}
},
"required": [
"from",
"match",
"replace",
"to"
],
"type": "object"
},
"VersionTransform": {
"additionalProperties": false,
"description": "VersionTransform allows mapping the package version to an APK version",
"properties": {
"match": {
"description": "Required: The regular expression to match against the `package.version` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
}
},
"required": [
"match",
"replace"
],
"type": "object"
}
},
"$id": "https://chainguard.dev/melange/pkg/config/configuration",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
chainguard-dev/melange | 31a4c303e9f3edc87549ba091e589dc9eb56ca39 | 2024-04-29T11:54:08 | pkg/config/schema.json | 367 | 2024-05-27T05:33:19.976056Z | {
"$defs": {
"BuildOption": {
"additionalProperties": false,
"description": "BuildOption describes an optional deviation to a package build.",
"properties": {
"Environment": {
"$ref": "#/$defs/EnvironmentOption"
},
"Vars": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"required": [
"Vars",
"Environment"
],
"type": "object"
},
"Checks": {
"additionalProperties": false,
"properties": {
"disabled": {
"description": "Optional: disable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Optional: enable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "The root melange configuration",
"properties": {
"data": {
"description": "Optional: An arbitrary list of data that can be used via templating in the\npipeline",
"items": {
"$ref": "#/$defs/RangeData"
},
"type": "array"
},
"environment": {
"$ref": "#/$defs/ImageConfiguration",
"description": "The specification for the packages build environment"
},
"options": {
"additionalProperties": {
"$ref": "#/$defs/BuildOption"
},
"description": "Optional: Deviations to the build",
"type": "object"
},
"package": {
"$ref": "#/$defs/Package",
"description": "Package metadata"
},
"pipeline": {
"description": "Required: The list of pipelines that produce the package.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"subpackages": {
"description": "Optional: The list of subpackages that this package also produces.",
"items": {
"$ref": "#/$defs/Subpackage"
},
"type": "array"
},
"test": {
"$ref": "#/$defs/Test",
"description": "Test section for the main package."
},
"update": {
"$ref": "#/$defs/Update",
"description": "Optional: The update block determining how this package is auto updated"
},
"var-transforms": {
"description": "Optional: A list of transformations to create for the builtin template\nvariables",
"items": {
"$ref": "#/$defs/VarTransforms"
},
"type": "array"
},
"vars": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: A map of arbitrary variables that can be used via templating in\nthe pipeline",
"type": "object"
}
},
"required": [
"package",
"environment"
],
"type": "object"
},
"ContentsOption": {
"additionalProperties": false,
"description": "ContentsOption describes an optional deviation to an apko environment's contents block.",
"properties": {
"Packages": {
"$ref": "#/$defs/ListOption"
}
},
"required": [
"Packages"
],
"type": "object"
},
"Copyright": {
"additionalProperties": false,
"properties": {
"attestation": {
"description": "Optional: Attestations of the license",
"type": "string"
},
"license": {
"description": "Required: The license for this package",
"type": "string"
},
"paths": {
"description": "Optional: The license paths, typically '*'",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"license"
],
"type": "object"
},
"DataItems": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Dependencies": {
"additionalProperties": false,
"properties": {
"provider-priority": {
"description": "Optional: An integer string compared against other equal package provides used to\ndetermine priority of provides",
"type": "string"
},
"provides": {
"description": "Optional: List of packages provided",
"items": {
"type": "string"
},
"type": "array"
},
"replaces": {
"description": "Optional: List of replace objectives",
"items": {
"type": "string"
},
"type": "array"
},
"replaces-priority": {
"description": "Optional: An integer string compared against other equal package provides used to\ndetermine priority of file replacements",
"type": "string"
},
"runtime": {
"description": "Optional: List of runtime dependencies",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"EnvironmentOption": {
"additionalProperties": false,
"description": "EnvironmentOption describes an optional deviation to an apko environment.",
"properties": {
"Contents": {
"$ref": "#/$defs/ContentsOption"
}
},
"required": [
"Contents"
],
"type": "object"
},
"GitHubMonitor": {
"additionalProperties": false,
"description": "GitHubMonitor indicates using the GitHub API",
"properties": {
"identifier": {
"description": "Org/repo for GitHub",
"type": "string"
},
"strip-prefix": {
"description": "If the version in GitHub contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in GitHub contains a suffix which should be ignored",
"type": "string"
},
"tag-filter": {
"description": "Filter to apply when searching tags on a GitHub repository\nDeprecated: Use TagFilterPrefix instead",
"type": "string"
},
"tag-filter-contains": {
"description": "Filter to apply when searching tags on a GitHub repository",
"type": "string"
},
"tag-filter-prefix": {
"description": "Prefix filter to apply when searching tags on a GitHub repository",
"type": "string"
},
"use-tag": {
"description": "Override the default of using a GitHub release to identify related tag to\nfetch. Not all projects use GitHub releases but just use tags",
"type": "boolean"
}
},
"required": [
"identifier"
],
"type": "object"
},
"Group": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"groupname": {
"type": "string"
},
"members": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageAccounts": {
"additionalProperties": false,
"properties": {
"groups": {
"items": {
"$ref": "#/$defs/Group"
},
"type": "array"
},
"run-as": {
"type": "string"
},
"users": {
"items": {
"$ref": "#/$defs/User"
},
"type": "array"
}
},
"type": "object"
},
"ImageConfiguration": {
"additionalProperties": false,
"properties": {
"accounts": {
"$ref": "#/$defs/ImageAccounts"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"archs": {
"items": {
"type": "string"
},
"type": "array"
},
"cmd": {
"type": "string"
},
"contents": {
"$ref": "#/$defs/ImageContents"
},
"entrypoint": {
"$ref": "#/$defs/ImageEntrypoint"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"include": {
"type": "string"
},
"os-release": {
"$ref": "#/$defs/OSRelease"
},
"paths": {
"items": {
"$ref": "#/$defs/PathMutation"
},
"type": "array"
},
"stop-signal": {
"type": "string"
},
"vcs-url": {
"type": "string"
},
"volumes": {
"items": {
"type": "string"
},
"type": "array"
},
"work-dir": {
"type": "string"
}
},
"type": "object"
},
"ImageContents": {
"additionalProperties": false,
"properties": {
"keyring": {
"items": {
"type": "string"
},
"type": "array"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"repositories": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageEntrypoint": {
"additionalProperties": false,
"properties": {
"command": {
"type": "string"
},
"services": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"shell-fragment": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"Input": {
"additionalProperties": false,
"properties": {
"default": {
"description": "Optional: The default value of the input. Required when the input is.",
"type": "string"
},
"description": {
"description": "Optional: The human readable description of the input",
"type": "string"
},
"required": {
"description": "Optional: A toggle denoting whether the input is required or not",
"type": "boolean"
}
},
"type": "object"
},
"ListOption": {
"additionalProperties": false,
"description": "ListOption describes an optional deviation to a list, for example, a list of packages.",
"properties": {
"Add": {
"items": {
"type": "string"
},
"type": "array"
},
"Remove": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Add",
"Remove"
],
"type": "object"
},
"Needs": {
"additionalProperties": false,
"properties": {
"Packages": {
"description": "A list of packages needed by this pipeline",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Packages"
],
"type": "object"
},
"OSRelease": {
"additionalProperties": false,
"properties": {
"bug-report-url": {
"type": "string"
},
"home-url": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"pretty-name": {
"type": "string"
},
"version-id": {
"type": "string"
}
},
"type": "object"
},
"Package": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the package build configuration",
"type": "string"
},
"copyright": {
"description": "The list of copyrights for this package",
"items": {
"$ref": "#/$defs/Copyright"
},
"type": "array"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "List of packages to depends on"
},
"description": {
"description": "A human readable description of the package",
"type": "string"
},
"epoch": {
"description": "The monotone increasing epoch of the package",
"type": "integer"
},
"name": {
"description": "The name of the package",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Optional: Resources to allocate to the build."
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets",
"description": "Optional: Executable scripts that run at various stages of the package\nlifecycle, triggered by configurable events"
},
"target-architecture": {
"description": "List of target architectures for which this package should be build for",
"items": {
"type": "string"
},
"type": "array"
},
"timeout": {
"description": "Optional: The amount of time to allow this build to take before timing out.",
"type": "integer"
},
"url": {
"description": "The URL to the package's homepage",
"type": "string"
},
"version": {
"description": "The version of the package",
"type": "string"
}
},
"required": [
"name",
"version",
"epoch"
],
"type": "object"
},
"PackageOption": {
"additionalProperties": false,
"properties": {
"no-commands": {
"description": "Optional: Mark this package as not providing any executables",
"type": "boolean"
},
"no-depends": {
"description": "Optional: Mark this package as a self contained package that does not\ndepend on any other package",
"type": "boolean"
},
"no-provides": {
"description": "Optional: Signify this package as a virtual package which does not provide\nany files, executables, libraries, etc... and is otherwise empty",
"type": "boolean"
}
},
"required": [
"no-provides",
"no-depends",
"no-commands"
],
"type": "object"
},
"PathMutation": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
},
"recursive": {
"type": "boolean"
},
"source": {
"type": "string"
},
"type": {
"type": "string"
},
"uid": {
"type": "integer"
}
},
"type": "object"
},
"Pipeline": {
"additionalProperties": false,
"properties": {
"assertions": {
"$ref": "#/$defs/PipelineAssertions",
"description": "Optional: Assertions to evaluate whether the pipeline was successful"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: environment variables to override the apko environment",
"type": "object"
},
"if": {
"description": "Optional: A condition to evaluate before running the pipeline",
"type": "string"
},
"inputs": {
"additionalProperties": {
"$ref": "#/$defs/Input"
},
"description": "Optional: A map of inputs to the pipeline",
"type": "object"
},
"label": {
"description": "Optional: Labels to apply to the pipeline",
"type": "string"
},
"name": {
"description": "Optional: A user defined name for the pipeline",
"type": "string"
},
"needs": {
"$ref": "#/$defs/Needs",
"description": "Optional: Configuration to determine any explicit dependencies this pipeline may have"
},
"pipeline": {
"description": "Optional: The list of pipelines to run.\n\nEach pipeline runs in it's own context that is not shared between other\npipelines. To share context between pipelines, nest a pipeline within an\nexisting pipeline. This can be useful when you wish to share common\nconfiguration, such as an alternative `working-directory`.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"runs": {
"description": "Optional: The command to run using the builder's shell (/bin/sh)",
"type": "string"
},
"uses": {
"description": "Optional: A named reusable pipeline to run\n\nThis can be either a pipeline builtin to melange, or a user defined named pipeline.\nFor example, to use a builtin melange pipeline:\n\t\tuses: autoconf/make",
"type": "string"
},
"with": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Arguments passed to the reusable pipelines defined in `uses`",
"type": "object"
},
"working-directory": {
"description": "Optional: The working directory of the pipeline\n\nThis defaults to the guests' build workspace (/home/build)",
"type": "string"
}
},
"type": "object"
},
"PipelineAssertions": {
"additionalProperties": false,
"properties": {
"required-steps": {
"description": "The number (an int) of required steps that must complete successfully\nwithin the asserted pipeline.",
"type": "integer"
}
},
"type": "object"
},
"RangeData": {
"additionalProperties": false,
"properties": {
"items": {
"$ref": "#/$defs/DataItems"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"items"
],
"type": "object"
},
"ReleaseMonitor": {
"additionalProperties": false,
"description": "ReleaseMonitor indicates using the API for https://release-monitoring.org/",
"properties": {
"identifier": {
"description": "Required: ID number for release monitor",
"type": "integer"
},
"strip-prefix": {
"description": "If the version in release monitor contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in release monitor contains a suffix which should be ignored",
"type": "string"
}
},
"required": [
"identifier"
],
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"Scriptlets": {
"additionalProperties": false,
"properties": {
"post-deinstall": {
"description": "Optional: The script to run after uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"post-install": {
"description": "Optional: The script to run post install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"post-upgrade": {
"description": "Optional: The script to run after upgrading. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-deinstall": {
"description": "Optional: The script to run before uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"pre-install": {
"description": "Optional: The script to run pre install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-upgrade": {
"description": "Optional: The script to run before upgrading. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"trigger": {
"$ref": "#/$defs/Trigger",
"description": "Optional: A script to run on a custom trigger"
}
},
"type": "object"
},
"Subpackage": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the subpackage build configuration",
"type": "string"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "Optional: List of packages to depend on"
},
"description": {
"description": "Optional: The human readable description of the subpackage",
"type": "string"
},
"if": {
"description": "Optional: A conditional statement to evaluate for the subpackage",
"type": "string"
},
"name": {
"description": "Required: Name of the subpackage",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"pipeline": {
"description": "Optional: The list of pipelines that produce subpackage.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"range": {
"description": "Optional: The iterable used to generate multiple subpackages",
"type": "string"
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets"
},
"test": {
"$ref": "#/$defs/Test",
"description": "Test section for the subpackage."
},
"url": {
"description": "Optional: The URL to the package's homepage",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Test": {
"additionalProperties": false,
"properties": {
"environment": {
"$ref": "#/$defs/ImageConfiguration",
"description": "Additional Environment necessary for test.\nEnvironment.Contents.Packages automatically get\npackage.dependencies.runtime added to it. So, if your test needs\nno additional packages, you can leave it blank."
},
"pipeline": {
"description": "Required: The list of pipelines that test the produced package.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
}
},
"required": [
"environment",
"pipeline"
],
"type": "object"
},
"Trigger": {
"additionalProperties": false,
"properties": {
"paths": {
"description": "Optional: The list of paths to monitor to trigger the script",
"items": {
"type": "string"
},
"type": "array"
},
"script": {
"description": "Optional: The script to run",
"type": "string"
}
},
"type": "object"
},
"Update": {
"additionalProperties": false,
"description": "Update provides information used to describe how to keep the package up to date",
"properties": {
"enabled": {
"description": "Toggle if updates should occur",
"type": "boolean"
},
"github": {
"$ref": "#/$defs/GitHubMonitor",
"description": "The configuration block for updates tracked via the Github API"
},
"ignore-regex-patterns": {
"description": "A slice of regex patterns to match an upstream version and ignore",
"items": {
"type": "string"
},
"type": "array"
},
"manual": {
"description": "Indicates that this package should be manually updated, usually taking\ncare over special version numbers",
"type": "boolean"
},
"release-monitor": {
"$ref": "#/$defs/ReleaseMonitor",
"description": "The configuration block for updates tracked via release-monitoring.org"
},
"shared": {
"description": "Indicate that an update to this package requires an epoch bump of\ndownstream dependencies, e.g. golang, java",
"type": "boolean"
},
"version-separator": {
"description": "Override the version separator if it is nonstandard",
"type": "string"
},
"version-transform": {
"description": "The configuration block for transforming the `package.version` into an APK version",
"items": {
"$ref": "#/$defs/VersionTransform"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"User": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"uid": {
"type": "integer"
},
"username": {
"type": "string"
}
},
"type": "object"
},
"VarTransforms": {
"additionalProperties": false,
"properties": {
"from": {
"description": "Required: The original template variable.\n\nExample: ${{package.version}}",
"type": "string"
},
"match": {
"description": "Required: The regular expression to match against the `from` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
},
"to": {
"description": "Required: The name of the new variable to create\n\nExample: mangeled-package-version",
"type": "string"
}
},
"required": [
"from",
"match",
"replace",
"to"
],
"type": "object"
},
"VersionTransform": {
"additionalProperties": false,
"description": "VersionTransform allows mapping the package version to an APK version",
"properties": {
"match": {
"description": "Required: The regular expression to match against the `package.version` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
}
},
"required": [
"match",
"replace"
],
"type": "object"
}
},
"$id": "https://chainguard.dev/melange/pkg/config/configuration",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
chainguard-dev/melange | f611e9af4dd16dc38030d748f6e799a669b3ff07 | 2024-04-23T23:21:40 | pkg/config/schema.json | 367 | 2024-05-27T05:33:19.976056Z | {
"$defs": {
"BuildOption": {
"additionalProperties": false,
"description": "BuildOption describes an optional deviation to a package build.",
"properties": {
"Environment": {
"$ref": "#/$defs/EnvironmentOption"
},
"Vars": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"required": [
"Vars",
"Environment"
],
"type": "object"
},
"Checks": {
"additionalProperties": false,
"properties": {
"disabled": {
"description": "Optional: disable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Optional: enable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "The root melange configuration",
"properties": {
"data": {
"description": "Optional: An arbitrary list of data that can be used via templating in the\npipeline",
"items": {
"$ref": "#/$defs/RangeData"
},
"type": "array"
},
"environment": {
"$ref": "#/$defs/ImageConfiguration",
"description": "The specification for the packages build environment"
},
"options": {
"additionalProperties": {
"$ref": "#/$defs/BuildOption"
},
"description": "Optional: Deviations to the build",
"type": "object"
},
"package": {
"$ref": "#/$defs/Package",
"description": "Package metadata"
},
"pipeline": {
"description": "Required: The list of pipelines that produce the package.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"subpackages": {
"description": "Optional: The list of subpackages that this package also produces.",
"items": {
"$ref": "#/$defs/Subpackage"
},
"type": "array"
},
"test": {
"$ref": "#/$defs/Test",
"description": "Test section for the main package."
},
"update": {
"$ref": "#/$defs/Update",
"description": "Optional: The update block determining how this package is auto updated"
},
"var-transforms": {
"description": "Optional: A list of transformations to create for the builtin template\nvariables",
"items": {
"$ref": "#/$defs/VarTransforms"
},
"type": "array"
},
"vars": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: A map of arbitrary variables that can be used via templating in\nthe pipeline",
"type": "object"
}
},
"required": [
"package",
"environment"
],
"type": "object"
},
"ContentsOption": {
"additionalProperties": false,
"description": "ContentsOption describes an optional deviation to an apko environment's contents block.",
"properties": {
"Packages": {
"$ref": "#/$defs/ListOption"
}
},
"required": [
"Packages"
],
"type": "object"
},
"Copyright": {
"additionalProperties": false,
"properties": {
"attestation": {
"description": "Optional: Attestations of the license",
"type": "string"
},
"license": {
"description": "Required: The license for this package",
"type": "string"
},
"paths": {
"description": "Optional: The license paths, typically '*'",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"license"
],
"type": "object"
},
"DataItems": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Dependencies": {
"additionalProperties": false,
"properties": {
"provider-priority": {
"description": "Optional: An integer compared against other equal package provides used to\ndetermine priority",
"type": "integer"
},
"provides": {
"description": "Optional: List of packages provided",
"items": {
"type": "string"
},
"type": "array"
},
"replaces": {
"description": "Optional: List of replace objectives",
"items": {
"type": "string"
},
"type": "array"
},
"runtime": {
"description": "Optional: List of runtime dependencies",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"EnvironmentOption": {
"additionalProperties": false,
"description": "EnvironmentOption describes an optional deviation to an apko environment.",
"properties": {
"Contents": {
"$ref": "#/$defs/ContentsOption"
}
},
"required": [
"Contents"
],
"type": "object"
},
"GitHubMonitor": {
"additionalProperties": false,
"description": "GitHubMonitor indicates using the GitHub API",
"properties": {
"identifier": {
"description": "Org/repo for GitHub",
"type": "string"
},
"strip-prefix": {
"description": "If the version in GitHub contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in GitHub contains a suffix which should be ignored",
"type": "string"
},
"tag-filter": {
"description": "Filter to apply when searching tags on a GitHub repository\nDeprecated: Use TagFilterPrefix instead",
"type": "string"
},
"tag-filter-contains": {
"description": "Filter to apply when searching tags on a GitHub repository",
"type": "string"
},
"tag-filter-prefix": {
"description": "Prefix filter to apply when searching tags on a GitHub repository",
"type": "string"
},
"use-tag": {
"description": "Override the default of using a GitHub release to identify related tag to\nfetch. Not all projects use GitHub releases but just use tags",
"type": "boolean"
}
},
"required": [
"identifier"
],
"type": "object"
},
"Group": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"groupname": {
"type": "string"
},
"members": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageAccounts": {
"additionalProperties": false,
"properties": {
"groups": {
"items": {
"$ref": "#/$defs/Group"
},
"type": "array"
},
"run-as": {
"type": "string"
},
"users": {
"items": {
"$ref": "#/$defs/User"
},
"type": "array"
}
},
"type": "object"
},
"ImageConfiguration": {
"additionalProperties": false,
"properties": {
"accounts": {
"$ref": "#/$defs/ImageAccounts"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"archs": {
"items": {
"type": "string"
},
"type": "array"
},
"cmd": {
"type": "string"
},
"contents": {
"$ref": "#/$defs/ImageContents"
},
"entrypoint": {
"$ref": "#/$defs/ImageEntrypoint"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"include": {
"type": "string"
},
"os-release": {
"$ref": "#/$defs/OSRelease"
},
"paths": {
"items": {
"$ref": "#/$defs/PathMutation"
},
"type": "array"
},
"stop-signal": {
"type": "string"
},
"vcs-url": {
"type": "string"
},
"volumes": {
"items": {
"type": "string"
},
"type": "array"
},
"work-dir": {
"type": "string"
}
},
"type": "object"
},
"ImageContents": {
"additionalProperties": false,
"properties": {
"keyring": {
"items": {
"type": "string"
},
"type": "array"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"repositories": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageEntrypoint": {
"additionalProperties": false,
"properties": {
"command": {
"type": "string"
},
"services": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"shell-fragment": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"Input": {
"additionalProperties": false,
"properties": {
"default": {
"description": "Optional: The default value of the input. Required when the input is.",
"type": "string"
},
"description": {
"description": "Optional: The human readable description of the input",
"type": "string"
},
"required": {
"description": "Optional: A toggle denoting whether the input is required or not",
"type": "boolean"
}
},
"type": "object"
},
"ListOption": {
"additionalProperties": false,
"description": "ListOption describes an optional deviation to a list, for example, a list of packages.",
"properties": {
"Add": {
"items": {
"type": "string"
},
"type": "array"
},
"Remove": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Add",
"Remove"
],
"type": "object"
},
"Needs": {
"additionalProperties": false,
"properties": {
"Packages": {
"description": "A list of packages needed by this pipeline",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Packages"
],
"type": "object"
},
"OSRelease": {
"additionalProperties": false,
"properties": {
"bug-report-url": {
"type": "string"
},
"home-url": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"pretty-name": {
"type": "string"
},
"version-id": {
"type": "string"
}
},
"type": "object"
},
"Package": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the package build configuration",
"type": "string"
},
"copyright": {
"description": "The list of copyrights for this package",
"items": {
"$ref": "#/$defs/Copyright"
},
"type": "array"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "List of packages to depends on"
},
"description": {
"description": "A human readable description of the package",
"type": "string"
},
"epoch": {
"description": "The monotone increasing epoch of the package",
"type": "integer"
},
"name": {
"description": "The name of the package",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Optional: Resources to allocate to the build."
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets",
"description": "Optional: Executable scripts that run at various stages of the package\nlifecycle, triggered by configurable events"
},
"target-architecture": {
"description": "List of target architectures for which this package should be build for",
"items": {
"type": "string"
},
"type": "array"
},
"timeout": {
"description": "Optional: The amount of time to allow this build to take before timing out.",
"type": "integer"
},
"url": {
"description": "The URL to the package's homepage",
"type": "string"
},
"version": {
"description": "The version of the package",
"type": "string"
}
},
"required": [
"name",
"version",
"epoch"
],
"type": "object"
},
"PackageOption": {
"additionalProperties": false,
"properties": {
"no-commands": {
"description": "Optional: Mark this package as not providing any executables",
"type": "boolean"
},
"no-depends": {
"description": "Optional: Mark this package as a self contained package that does not\ndepend on any other package",
"type": "boolean"
},
"no-provides": {
"description": "Optional: Signify this package as a virtual package which does not provide\nany files, executables, libraries, etc... and is otherwise empty",
"type": "boolean"
}
},
"required": [
"no-provides",
"no-depends",
"no-commands"
],
"type": "object"
},
"PathMutation": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
},
"recursive": {
"type": "boolean"
},
"source": {
"type": "string"
},
"type": {
"type": "string"
},
"uid": {
"type": "integer"
}
},
"type": "object"
},
"Pipeline": {
"additionalProperties": false,
"properties": {
"assertions": {
"$ref": "#/$defs/PipelineAssertions",
"description": "Optional: Assertions to evaluate whether the pipeline was successful"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: environment variables to override the apko environment",
"type": "object"
},
"if": {
"description": "Optional: A condition to evaluate before running the pipeline",
"type": "string"
},
"inputs": {
"additionalProperties": {
"$ref": "#/$defs/Input"
},
"description": "Optional: A map of inputs to the pipeline",
"type": "object"
},
"label": {
"description": "Optional: Labels to apply to the pipeline",
"type": "string"
},
"name": {
"description": "Optional: A user defined name for the pipeline",
"type": "string"
},
"needs": {
"$ref": "#/$defs/Needs",
"description": "Optional: Configuration to determine any explicit dependencies this pipeline may have"
},
"pipeline": {
"description": "Optional: The list of pipelines to run.\n\nEach pipeline runs in it's own context that is not shared between other\npipelines. To share context between pipelines, nest a pipeline within an\nexisting pipeline. This can be useful when you wish to share common\nconfiguration, such as an alternative `working-directory`.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"runs": {
"description": "Optional: The command to run using the builder's shell (/bin/sh)",
"type": "string"
},
"uses": {
"description": "Optional: A named reusable pipeline to run\n\nThis can be either a pipeline builtin to melange, or a user defined named pipeline.\nFor example, to use a builtin melange pipeline:\n\t\tuses: autoconf/make",
"type": "string"
},
"with": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Arguments passed to the reusable pipelines defined in `uses`",
"type": "object"
},
"working-directory": {
"description": "Optional: The working directory of the pipeline\n\nThis defaults to the guests' build workspace (/home/build)",
"type": "string"
}
},
"type": "object"
},
"PipelineAssertions": {
"additionalProperties": false,
"properties": {
"required-steps": {
"description": "The number (an int) of required steps that must complete successfully\nwithin the asserted pipeline.",
"type": "integer"
}
},
"type": "object"
},
"RangeData": {
"additionalProperties": false,
"properties": {
"items": {
"$ref": "#/$defs/DataItems"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"items"
],
"type": "object"
},
"ReleaseMonitor": {
"additionalProperties": false,
"description": "ReleaseMonitor indicates using the API for https://release-monitoring.org/",
"properties": {
"identifier": {
"description": "Required: ID number for release monitor",
"type": "integer"
},
"strip-prefix": {
"description": "If the version in release monitor contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in release monitor contains a suffix which should be ignored",
"type": "string"
}
},
"required": [
"identifier"
],
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"Scriptlets": {
"additionalProperties": false,
"properties": {
"post-deinstall": {
"description": "Optional: The script to run after uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"post-install": {
"description": "Optional: The script to run post install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"post-upgrade": {
"description": "Optional: The script to run after upgrading. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-deinstall": {
"description": "Optional: The script to run before uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"pre-install": {
"description": "Optional: The script to run pre install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-upgrade": {
"description": "Optional: The script to run before upgrading. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"trigger": {
"$ref": "#/$defs/Trigger",
"description": "Optional: A script to run on a custom trigger"
}
},
"type": "object"
},
"Subpackage": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the subpackage build configuration",
"type": "string"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "Optional: List of packages to depend on"
},
"description": {
"description": "Optional: The human readable description of the subpackage",
"type": "string"
},
"if": {
"description": "Optional: A conditional statement to evaluate for the subpackage",
"type": "string"
},
"name": {
"description": "Required: Name of the subpackage",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"pipeline": {
"description": "Optional: The list of pipelines that produce subpackage.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"range": {
"description": "Optional: The iterable used to generate multiple subpackages",
"type": "string"
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets"
},
"test": {
"$ref": "#/$defs/Test",
"description": "Test section for the subpackage."
},
"url": {
"description": "Optional: The URL to the package's homepage",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Test": {
"additionalProperties": false,
"properties": {
"environment": {
"$ref": "#/$defs/ImageConfiguration",
"description": "Additional Environment necessary for test.\nEnvironment.Contents.Packages automatically get\npackage.dependencies.runtime added to it. So, if your test needs\nno additional packages, you can leave it blank."
},
"pipeline": {
"description": "Required: The list of pipelines that test the produced package.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
}
},
"required": [
"environment",
"pipeline"
],
"type": "object"
},
"Trigger": {
"additionalProperties": false,
"properties": {
"paths": {
"description": "Optional: The list of paths to monitor to trigger the script",
"items": {
"type": "string"
},
"type": "array"
},
"script": {
"description": "Optional: The script to run",
"type": "string"
}
},
"type": "object"
},
"Update": {
"additionalProperties": false,
"description": "Update provides information used to describe how to keep the package up to date",
"properties": {
"enabled": {
"description": "Toggle if updates should occur",
"type": "boolean"
},
"github": {
"$ref": "#/$defs/GitHubMonitor",
"description": "The configuration block for updates tracked via the Github API"
},
"ignore-regex-patterns": {
"description": "A slice of regex patterns to match an upstream version and ignore",
"items": {
"type": "string"
},
"type": "array"
},
"manual": {
"description": "Indicates that this package should be manually updated, usually taking\ncare over special version numbers",
"type": "boolean"
},
"release-monitor": {
"$ref": "#/$defs/ReleaseMonitor",
"description": "The configuration block for updates tracked via release-monitoring.org"
},
"shared": {
"description": "Indicate that an update to this package requires an epoch bump of\ndownstream dependencies, e.g. golang, java",
"type": "boolean"
},
"version-separator": {
"description": "Override the version separator if it is nonstandard",
"type": "string"
},
"version-transform": {
"description": "The configuration block for transforming the `package.version` into an APK version",
"items": {
"$ref": "#/$defs/VersionTransform"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"User": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"uid": {
"type": "integer"
},
"username": {
"type": "string"
}
},
"type": "object"
},
"VarTransforms": {
"additionalProperties": false,
"properties": {
"from": {
"description": "Required: The original template variable.\n\nExample: ${{package.version}}",
"type": "string"
},
"match": {
"description": "Required: The regular expression to match against the `from` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
},
"to": {
"description": "Required: The name of the new variable to create\n\nExample: mangeled-package-version",
"type": "string"
}
},
"required": [
"from",
"match",
"replace",
"to"
],
"type": "object"
},
"VersionTransform": {
"additionalProperties": false,
"description": "VersionTransform allows mapping the package version to an APK version",
"properties": {
"match": {
"description": "Required: The regular expression to match against the `package.version` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
}
},
"required": [
"match",
"replace"
],
"type": "object"
}
},
"$id": "https://chainguard.dev/melange/pkg/config/configuration",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
chainguard-dev/melange | 8b434b9fd3b6f71423bdcd8d46f16c52e2cf3038 | 2023-12-13T17:31:29 | pkg/config/schema.json | 367 | 2024-05-27T05:33:19.976056Z | {
"$defs": {
"AccountsOption": {
"additionalProperties": false,
"properties": {
"RunAs": {
"type": "string"
}
},
"required": [
"RunAs"
],
"type": "object"
},
"BuildOption": {
"additionalProperties": false,
"properties": {
"Accounts": {
"$ref": "#/$defs/AccountsOption"
},
"Contents": {
"$ref": "#/$defs/ContentsOption"
},
"Entrypoint": {
"$ref": "#/$defs/ImageEntrypoint"
},
"Environment": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"required": [
"Contents",
"Accounts",
"Environment",
"Entrypoint"
],
"type": "object"
},
"Checks": {
"additionalProperties": false,
"properties": {
"disabled": {
"description": "Optional: disable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Optional: enable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "The root melange configuration",
"properties": {
"data": {
"description": "Optional: An arbitrary list of data that can be used via templating in the\npipeline",
"items": {
"$ref": "#/$defs/RangeData"
},
"type": "array"
},
"environment": {
"$ref": "#/$defs/ImageConfiguration",
"description": "The specification for the packages build environment"
},
"options": {
"additionalProperties": {
"$ref": "#/$defs/BuildOption"
},
"description": "Optional: Deviations to the build",
"type": "object"
},
"package": {
"$ref": "#/$defs/Package",
"description": "Package metadata"
},
"pipeline": {
"description": "Required: The list of pipelines that produce the package.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"subpackages": {
"description": "Optional: The list of subpackages that this package also produces.",
"items": {
"$ref": "#/$defs/Subpackage"
},
"type": "array"
},
"test": {
"$ref": "#/$defs/Test",
"description": "Test section for the main package."
},
"update": {
"$ref": "#/$defs/Update",
"description": "Optional: The update block determining how this package is auto updated"
},
"var-transforms": {
"description": "Optional: A list of transformations to create for the builtin template\nvariables",
"items": {
"$ref": "#/$defs/VarTransforms"
},
"type": "array"
},
"vars": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: A map of arbitrary variables that can be used via templating in\nthe pipeline",
"type": "object"
}
},
"required": [
"package",
"environment"
],
"type": "object"
},
"ContentsOption": {
"additionalProperties": false,
"properties": {
"Packages": {
"$ref": "#/$defs/ListOption"
}
},
"required": [
"Packages"
],
"type": "object"
},
"Copyright": {
"additionalProperties": false,
"properties": {
"attestation": {
"description": "Optional: Attestations of the license",
"type": "string"
},
"license": {
"description": "Required: The license for this package",
"type": "string"
},
"paths": {
"description": "Optional: The license paths, typically '*'",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"license"
],
"type": "object"
},
"DataItems": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Dependencies": {
"additionalProperties": false,
"properties": {
"provider-priority": {
"description": "Optional: An integer compared against other equal package provides used to\ndetermine priority",
"type": "integer"
},
"provides": {
"description": "Optional: List of packages provided",
"items": {
"type": "string"
},
"type": "array"
},
"replaces": {
"description": "Optional: List of replace objectives",
"items": {
"type": "string"
},
"type": "array"
},
"runtime": {
"description": "Optional: List of runtime dependencies",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GitHubMonitor": {
"additionalProperties": false,
"description": "GitHubMonitor indicates using the GitHub API",
"properties": {
"identifier": {
"description": "Org/repo for GitHub",
"type": "string"
},
"strip-prefix": {
"description": "If the version in GitHub contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in GitHub contains a suffix which should be ignored",
"type": "string"
},
"tag-filter": {
"description": "Filter to apply when searching tags on a GitHub repository\nDeprecated: Use TagFilterPrefix instead",
"type": "string"
},
"tag-filter-contains": {
"description": "Filter to apply when searching tags on a GitHub repository",
"type": "string"
},
"tag-filter-prefix": {
"description": "Prefix filter to apply when searching tags on a GitHub repository",
"type": "string"
},
"use-tag": {
"description": "Override the default of using a GitHub release to identify related tag to\nfetch. Not all projects use GitHub releases but just use tags",
"type": "boolean"
}
},
"required": [
"identifier"
],
"type": "object"
},
"Group": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"groupname": {
"type": "string"
},
"members": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageAccounts": {
"additionalProperties": false,
"properties": {
"groups": {
"items": {
"$ref": "#/$defs/Group"
},
"type": "array"
},
"run-as": {
"type": "string"
},
"users": {
"items": {
"$ref": "#/$defs/User"
},
"type": "array"
}
},
"type": "object"
},
"ImageConfiguration": {
"additionalProperties": false,
"properties": {
"accounts": {
"$ref": "#/$defs/ImageAccounts"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"archs": {
"items": {
"type": "string"
},
"type": "array"
},
"cmd": {
"type": "string"
},
"contents": {
"$ref": "#/$defs/ImageContents"
},
"entrypoint": {
"$ref": "#/$defs/ImageEntrypoint"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"include": {
"type": "string"
},
"options": {
"additionalProperties": {
"$ref": "#/$defs/BuildOption"
},
"type": "object"
},
"os-release": {
"$ref": "#/$defs/OSRelease"
},
"paths": {
"items": {
"$ref": "#/$defs/PathMutation"
},
"type": "array"
},
"stop-signal": {
"type": "string"
},
"vcs-url": {
"type": "string"
},
"volumes": {
"items": {
"type": "string"
},
"type": "array"
},
"work-dir": {
"type": "string"
}
},
"type": "object"
},
"ImageContents": {
"additionalProperties": false,
"properties": {
"keyring": {
"items": {
"type": "string"
},
"type": "array"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"repositories": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageEntrypoint": {
"additionalProperties": false,
"properties": {
"command": {
"type": "string"
},
"services": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"shell-fragment": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"Input": {
"additionalProperties": false,
"properties": {
"default": {
"description": "Optional: The default value of the input. Required when the input is.",
"type": "string"
},
"description": {
"description": "Optional: The human readable description of the input",
"type": "string"
},
"required": {
"description": "Optional: A toggle denoting whether the input is required or not",
"type": "boolean"
}
},
"type": "object"
},
"ListOption": {
"additionalProperties": false,
"properties": {
"Add": {
"items": {
"type": "string"
},
"type": "array"
},
"Remove": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Add",
"Remove"
],
"type": "object"
},
"Needs": {
"additionalProperties": false,
"properties": {
"Packages": {
"description": "A list of packages needed by this pipeline",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Packages"
],
"type": "object"
},
"OSRelease": {
"additionalProperties": false,
"properties": {
"bug-report-url": {
"type": "string"
},
"home-url": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"pretty-name": {
"type": "string"
},
"version-id": {
"type": "string"
}
},
"type": "object"
},
"Package": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the package build configuration",
"type": "string"
},
"copyright": {
"description": "The list of copyrights for this package",
"items": {
"$ref": "#/$defs/Copyright"
},
"type": "array"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "List of packages to depends on"
},
"description": {
"description": "A human readable description of the package",
"type": "string"
},
"epoch": {
"description": "The monotone increasing epoch of the package",
"type": "integer"
},
"name": {
"description": "The name of the package",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Optional: Resources to allocate to the build."
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets",
"description": "Optional: Executable scripts that run at various stages of the package\nlifecycle, triggered by configurable events"
},
"target-architecture": {
"description": "List of target architectures for which this package should be build for",
"items": {
"type": "string"
},
"type": "array"
},
"timeout": {
"description": "Optional: The amount of time to allow this build to take before timing out.",
"type": "integer"
},
"url": {
"description": "The URL to the package's homepage",
"type": "string"
},
"version": {
"description": "The version of the package",
"type": "string"
}
},
"required": [
"name",
"version",
"epoch"
],
"type": "object"
},
"PackageOption": {
"additionalProperties": false,
"properties": {
"no-commands": {
"description": "Optional: Mark this package as not providing any executables",
"type": "boolean"
},
"no-depends": {
"description": "Optional: Mark this package as a self contained package that does not\ndepend on any other package",
"type": "boolean"
},
"no-provides": {
"description": "Optional: Signify this package as a virtual package which does not provide\nany files, executables, libraries, etc... and is otherwise empty",
"type": "boolean"
}
},
"required": [
"no-provides",
"no-depends",
"no-commands"
],
"type": "object"
},
"PathMutation": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
},
"recursive": {
"type": "boolean"
},
"source": {
"type": "string"
},
"type": {
"type": "string"
},
"uid": {
"type": "integer"
}
},
"type": "object"
},
"Pipeline": {
"additionalProperties": false,
"properties": {
"assertions": {
"$ref": "#/$defs/PipelineAssertions",
"description": "Optional: Assertions to evaluate whether the pipeline was successful"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: environment variables to override the apko environment",
"type": "object"
},
"if": {
"description": "Optional: A condition to evaluate before running the pipeline",
"type": "string"
},
"inputs": {
"additionalProperties": {
"$ref": "#/$defs/Input"
},
"description": "Optional: A map of inputs to the pipeline",
"type": "object"
},
"label": {
"description": "Optional: Labels to apply to the pipeline",
"type": "string"
},
"name": {
"description": "Optional: A user defined name for the pipeline",
"type": "string"
},
"needs": {
"$ref": "#/$defs/Needs",
"description": "Optional: Configuration to determine any explicit dependencies this pipeline may have"
},
"pipeline": {
"description": "Optional: The list of pipelines to run.\n\nEach pipeline runs in it's own context that is not shared between other\npipelines. To share context between pipelines, nest a pipeline within an\nexisting pipeline. This can be useful when you wish to share common\nconfiguration, such as an alternative `working-directory`.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"runs": {
"description": "Optional: The command to run using the builder's shell (/bin/sh)",
"type": "string"
},
"uses": {
"description": "Optional: A named reusable pipeline to run\n\nThis can be either a pipeline builtin to melange, or a user defined named pipeline.\nFor example, to use a builtin melange pipeline:\n\t\tuses: autoconf/make",
"type": "string"
},
"with": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Arguments passed to the reusable pipelines defined in `uses`",
"type": "object"
},
"working-directory": {
"description": "Optional: The working directory of the pipeline\n\nThis defaults to the guests' build workspace (/home/build)",
"type": "string"
}
},
"type": "object"
},
"PipelineAssertions": {
"additionalProperties": false,
"properties": {
"required-steps": {
"description": "The number (an int) of required steps that must complete successfully\nwithin the asserted pipeline.",
"type": "integer"
}
},
"type": "object"
},
"RangeData": {
"additionalProperties": false,
"properties": {
"items": {
"$ref": "#/$defs/DataItems"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"items"
],
"type": "object"
},
"ReleaseMonitor": {
"additionalProperties": false,
"description": "ReleaseMonitor indicates using the API for https://release-monitoring.org/",
"properties": {
"identifier": {
"description": "Required: ID number for release monitor",
"type": "integer"
},
"strip-prefix": {
"description": "If the version in release monitor contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in release monitor contains a suffix which should be ignored",
"type": "string"
}
},
"required": [
"identifier"
],
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"Scriptlets": {
"additionalProperties": false,
"properties": {
"post-deinstall": {
"description": "Optional: The script to run after uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"post-install": {
"description": "Optional: The script to run post install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"post-upgrade": {
"description": "Optional: The script to run after upgrading. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-deinstall": {
"description": "Optional: The script to run before uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"pre-install": {
"description": "Optional: The script to run pre install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-upgrade": {
"description": "Optional: The script to run before upgrading. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"trigger": {
"additionalProperties": false,
"description": "Optional: A script to run on a custom trigger",
"properties": {
"paths": {
"items": {
"type": "string"
},
"type": "array"
},
"script": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"Subpackage": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the subpackage build configuration",
"type": "string"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "Optional: List of packages to depend on"
},
"description": {
"description": "Optional: The human readable description of the subpackage",
"type": "string"
},
"if": {
"description": "Optional: A conditional statement to evaluate for the subpackage",
"type": "string"
},
"name": {
"description": "Required: Name of the subpackage",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"pipeline": {
"description": "Optional: The list of pipelines that produce subpackage.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"range": {
"description": "Optional: The iterable used to generate multiple subpackages",
"type": "string"
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets"
},
"test": {
"$ref": "#/$defs/Test",
"description": "Test section for the subpackage."
},
"url": {
"description": "Optional: The URL to the package's homepage",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Test": {
"additionalProperties": false,
"properties": {
"Environment": {
"$ref": "#/$defs/ImageConfiguration",
"description": "Additional Environment necessary for test.\nEnvironment.Contents.Packages automatically get\npackage.dependencies.runtime added to it. So, if your test needs\nno additional packages, you can leave it blank."
},
"pipeline": {
"description": "Required: The list of pipelines that test the produced package.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
}
},
"required": [
"Environment",
"pipeline"
],
"type": "object"
},
"Update": {
"additionalProperties": false,
"description": "Update provides information used to describe how to keep the package up to date",
"properties": {
"enabled": {
"description": "Toggle if updates should occur",
"type": "boolean"
},
"github": {
"$ref": "#/$defs/GitHubMonitor",
"description": "The configuration block for updates tracked via the Github API"
},
"ignore-regex-patterns": {
"description": "A slice of regex patterns to match an upstream version and ignore",
"items": {
"type": "string"
},
"type": "array"
},
"manual": {
"description": "Indicates that this package should be manually updated, usually taking\ncare over special version numbers",
"type": "boolean"
},
"release-monitor": {
"$ref": "#/$defs/ReleaseMonitor",
"description": "The configuration block for updates tracked via release-monitoring.org"
},
"shared": {
"description": "Indicate that an update to this package requires an epoch bump of\ndownstream dependencies, e.g. golang, java",
"type": "boolean"
},
"version-separator": {
"description": "Override the version separator if it is nonstandard",
"type": "string"
},
"version-transform": {
"description": "The configuration block for transforming the `package.version` into an APK version",
"items": {
"$ref": "#/$defs/VersionTransform"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"User": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"uid": {
"type": "integer"
},
"username": {
"type": "string"
}
},
"type": "object"
},
"VarTransforms": {
"additionalProperties": false,
"properties": {
"from": {
"description": "Required: The original template variable.\n\nExample: ${{package.version}}",
"type": "string"
},
"match": {
"description": "Required: The regular expression to match against the `from` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
},
"to": {
"description": "Required: The name of the new variable to create\n\nExample: mangeled-package-version",
"type": "string"
}
},
"required": [
"from",
"match",
"replace",
"to"
],
"type": "object"
},
"VersionTransform": {
"additionalProperties": false,
"description": "VersionTransform allows mapping the package version to an APK version",
"properties": {
"match": {
"description": "Required: The regular expression to match against the `package.version` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
}
},
"required": [
"match",
"replace"
],
"type": "object"
}
},
"$id": "https://chainguard.dev/melange/pkg/config/configuration",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
chainguard-dev/melange | 2f5a7d1aa119e06f4d3515a5a4b9d73195eb5752 | 2024-04-26T22:20:32 | pkg/config/schema.json | 367 | 2024-05-27T05:33:19.976056Z | {
"$defs": {
"BuildOption": {
"additionalProperties": false,
"description": "BuildOption describes an optional deviation to a package build.",
"properties": {
"Environment": {
"$ref": "#/$defs/EnvironmentOption"
},
"Vars": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"required": [
"Vars",
"Environment"
],
"type": "object"
},
"Checks": {
"additionalProperties": false,
"properties": {
"disabled": {
"description": "Optional: disable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Optional: enable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "The root melange configuration",
"properties": {
"data": {
"description": "Optional: An arbitrary list of data that can be used via templating in the\npipeline",
"items": {
"$ref": "#/$defs/RangeData"
},
"type": "array"
},
"environment": {
"$ref": "#/$defs/ImageConfiguration",
"description": "The specification for the packages build environment"
},
"options": {
"additionalProperties": {
"$ref": "#/$defs/BuildOption"
},
"description": "Optional: Deviations to the build",
"type": "object"
},
"package": {
"$ref": "#/$defs/Package",
"description": "Package metadata"
},
"pipeline": {
"description": "Required: The list of pipelines that produce the package.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"subpackages": {
"description": "Optional: The list of subpackages that this package also produces.",
"items": {
"$ref": "#/$defs/Subpackage"
},
"type": "array"
},
"test": {
"$ref": "#/$defs/Test",
"description": "Test section for the main package."
},
"update": {
"$ref": "#/$defs/Update",
"description": "Optional: The update block determining how this package is auto updated"
},
"var-transforms": {
"description": "Optional: A list of transformations to create for the builtin template\nvariables",
"items": {
"$ref": "#/$defs/VarTransforms"
},
"type": "array"
},
"vars": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: A map of arbitrary variables that can be used via templating in\nthe pipeline",
"type": "object"
}
},
"required": [
"package",
"environment"
],
"type": "object"
},
"ContentsOption": {
"additionalProperties": false,
"description": "ContentsOption describes an optional deviation to an apko environment's contents block.",
"properties": {
"Packages": {
"$ref": "#/$defs/ListOption"
}
},
"required": [
"Packages"
],
"type": "object"
},
"Copyright": {
"additionalProperties": false,
"properties": {
"attestation": {
"description": "Optional: Attestations of the license",
"type": "string"
},
"license": {
"description": "Required: The license for this package",
"type": "string"
},
"paths": {
"description": "Optional: The license paths, typically '*'",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"license"
],
"type": "object"
},
"DataItems": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Dependencies": {
"additionalProperties": false,
"properties": {
"provider-priority": {
"description": "Optional: An integer compared against other equal package provides used to\ndetermine priority of provides",
"type": "string"
},
"provides": {
"description": "Optional: List of packages provided",
"items": {
"type": "string"
},
"type": "array"
},
"replaces": {
"description": "Optional: List of replace objectives",
"items": {
"type": "string"
},
"type": "array"
},
"replaces-priority": {
"description": "Optional: An integer compared against other equal package provides used to\ndetermine priority of file replacements",
"type": "string"
},
"runtime": {
"description": "Optional: List of runtime dependencies",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"EnvironmentOption": {
"additionalProperties": false,
"description": "EnvironmentOption describes an optional deviation to an apko environment.",
"properties": {
"Contents": {
"$ref": "#/$defs/ContentsOption"
}
},
"required": [
"Contents"
],
"type": "object"
},
"GitHubMonitor": {
"additionalProperties": false,
"description": "GitHubMonitor indicates using the GitHub API",
"properties": {
"identifier": {
"description": "Org/repo for GitHub",
"type": "string"
},
"strip-prefix": {
"description": "If the version in GitHub contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in GitHub contains a suffix which should be ignored",
"type": "string"
},
"tag-filter": {
"description": "Filter to apply when searching tags on a GitHub repository\nDeprecated: Use TagFilterPrefix instead",
"type": "string"
},
"tag-filter-contains": {
"description": "Filter to apply when searching tags on a GitHub repository",
"type": "string"
},
"tag-filter-prefix": {
"description": "Prefix filter to apply when searching tags on a GitHub repository",
"type": "string"
},
"use-tag": {
"description": "Override the default of using a GitHub release to identify related tag to\nfetch. Not all projects use GitHub releases but just use tags",
"type": "boolean"
}
},
"required": [
"identifier"
],
"type": "object"
},
"Group": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"groupname": {
"type": "string"
},
"members": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageAccounts": {
"additionalProperties": false,
"properties": {
"groups": {
"items": {
"$ref": "#/$defs/Group"
},
"type": "array"
},
"run-as": {
"type": "string"
},
"users": {
"items": {
"$ref": "#/$defs/User"
},
"type": "array"
}
},
"type": "object"
},
"ImageConfiguration": {
"additionalProperties": false,
"properties": {
"accounts": {
"$ref": "#/$defs/ImageAccounts"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"archs": {
"items": {
"type": "string"
},
"type": "array"
},
"cmd": {
"type": "string"
},
"contents": {
"$ref": "#/$defs/ImageContents"
},
"entrypoint": {
"$ref": "#/$defs/ImageEntrypoint"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"include": {
"type": "string"
},
"os-release": {
"$ref": "#/$defs/OSRelease"
},
"paths": {
"items": {
"$ref": "#/$defs/PathMutation"
},
"type": "array"
},
"stop-signal": {
"type": "string"
},
"vcs-url": {
"type": "string"
},
"volumes": {
"items": {
"type": "string"
},
"type": "array"
},
"work-dir": {
"type": "string"
}
},
"type": "object"
},
"ImageContents": {
"additionalProperties": false,
"properties": {
"keyring": {
"items": {
"type": "string"
},
"type": "array"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"repositories": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageEntrypoint": {
"additionalProperties": false,
"properties": {
"command": {
"type": "string"
},
"services": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"shell-fragment": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"Input": {
"additionalProperties": false,
"properties": {
"default": {
"description": "Optional: The default value of the input. Required when the input is.",
"type": "string"
},
"description": {
"description": "Optional: The human readable description of the input",
"type": "string"
},
"required": {
"description": "Optional: A toggle denoting whether the input is required or not",
"type": "boolean"
}
},
"type": "object"
},
"ListOption": {
"additionalProperties": false,
"description": "ListOption describes an optional deviation to a list, for example, a list of packages.",
"properties": {
"Add": {
"items": {
"type": "string"
},
"type": "array"
},
"Remove": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Add",
"Remove"
],
"type": "object"
},
"Needs": {
"additionalProperties": false,
"properties": {
"Packages": {
"description": "A list of packages needed by this pipeline",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Packages"
],
"type": "object"
},
"OSRelease": {
"additionalProperties": false,
"properties": {
"bug-report-url": {
"type": "string"
},
"home-url": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"pretty-name": {
"type": "string"
},
"version-id": {
"type": "string"
}
},
"type": "object"
},
"Package": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the package build configuration",
"type": "string"
},
"copyright": {
"description": "The list of copyrights for this package",
"items": {
"$ref": "#/$defs/Copyright"
},
"type": "array"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "List of packages to depends on"
},
"description": {
"description": "A human readable description of the package",
"type": "string"
},
"epoch": {
"description": "The monotone increasing epoch of the package",
"type": "integer"
},
"name": {
"description": "The name of the package",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Optional: Resources to allocate to the build."
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets",
"description": "Optional: Executable scripts that run at various stages of the package\nlifecycle, triggered by configurable events"
},
"target-architecture": {
"description": "List of target architectures for which this package should be build for",
"items": {
"type": "string"
},
"type": "array"
},
"timeout": {
"description": "Optional: The amount of time to allow this build to take before timing out.",
"type": "integer"
},
"url": {
"description": "The URL to the package's homepage",
"type": "string"
},
"version": {
"description": "The version of the package",
"type": "string"
}
},
"required": [
"name",
"version",
"epoch"
],
"type": "object"
},
"PackageOption": {
"additionalProperties": false,
"properties": {
"no-commands": {
"description": "Optional: Mark this package as not providing any executables",
"type": "boolean"
},
"no-depends": {
"description": "Optional: Mark this package as a self contained package that does not\ndepend on any other package",
"type": "boolean"
},
"no-provides": {
"description": "Optional: Signify this package as a virtual package which does not provide\nany files, executables, libraries, etc... and is otherwise empty",
"type": "boolean"
}
},
"required": [
"no-provides",
"no-depends",
"no-commands"
],
"type": "object"
},
"PathMutation": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
},
"recursive": {
"type": "boolean"
},
"source": {
"type": "string"
},
"type": {
"type": "string"
},
"uid": {
"type": "integer"
}
},
"type": "object"
},
"Pipeline": {
"additionalProperties": false,
"properties": {
"assertions": {
"$ref": "#/$defs/PipelineAssertions",
"description": "Optional: Assertions to evaluate whether the pipeline was successful"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: environment variables to override the apko environment",
"type": "object"
},
"if": {
"description": "Optional: A condition to evaluate before running the pipeline",
"type": "string"
},
"inputs": {
"additionalProperties": {
"$ref": "#/$defs/Input"
},
"description": "Optional: A map of inputs to the pipeline",
"type": "object"
},
"label": {
"description": "Optional: Labels to apply to the pipeline",
"type": "string"
},
"name": {
"description": "Optional: A user defined name for the pipeline",
"type": "string"
},
"needs": {
"$ref": "#/$defs/Needs",
"description": "Optional: Configuration to determine any explicit dependencies this pipeline may have"
},
"pipeline": {
"description": "Optional: The list of pipelines to run.\n\nEach pipeline runs in it's own context that is not shared between other\npipelines. To share context between pipelines, nest a pipeline within an\nexisting pipeline. This can be useful when you wish to share common\nconfiguration, such as an alternative `working-directory`.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"runs": {
"description": "Optional: The command to run using the builder's shell (/bin/sh)",
"type": "string"
},
"uses": {
"description": "Optional: A named reusable pipeline to run\n\nThis can be either a pipeline builtin to melange, or a user defined named pipeline.\nFor example, to use a builtin melange pipeline:\n\t\tuses: autoconf/make",
"type": "string"
},
"with": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Arguments passed to the reusable pipelines defined in `uses`",
"type": "object"
},
"working-directory": {
"description": "Optional: The working directory of the pipeline\n\nThis defaults to the guests' build workspace (/home/build)",
"type": "string"
}
},
"type": "object"
},
"PipelineAssertions": {
"additionalProperties": false,
"properties": {
"required-steps": {
"description": "The number (an int) of required steps that must complete successfully\nwithin the asserted pipeline.",
"type": "integer"
}
},
"type": "object"
},
"RangeData": {
"additionalProperties": false,
"properties": {
"items": {
"$ref": "#/$defs/DataItems"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"items"
],
"type": "object"
},
"ReleaseMonitor": {
"additionalProperties": false,
"description": "ReleaseMonitor indicates using the API for https://release-monitoring.org/",
"properties": {
"identifier": {
"description": "Required: ID number for release monitor",
"type": "integer"
},
"strip-prefix": {
"description": "If the version in release monitor contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in release monitor contains a suffix which should be ignored",
"type": "string"
}
},
"required": [
"identifier"
],
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"Scriptlets": {
"additionalProperties": false,
"properties": {
"post-deinstall": {
"description": "Optional: The script to run after uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"post-install": {
"description": "Optional: The script to run post install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"post-upgrade": {
"description": "Optional: The script to run after upgrading. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-deinstall": {
"description": "Optional: The script to run before uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"pre-install": {
"description": "Optional: The script to run pre install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-upgrade": {
"description": "Optional: The script to run before upgrading. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"trigger": {
"$ref": "#/$defs/Trigger",
"description": "Optional: A script to run on a custom trigger"
}
},
"type": "object"
},
"Subpackage": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the subpackage build configuration",
"type": "string"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "Optional: List of packages to depend on"
},
"description": {
"description": "Optional: The human readable description of the subpackage",
"type": "string"
},
"if": {
"description": "Optional: A conditional statement to evaluate for the subpackage",
"type": "string"
},
"name": {
"description": "Required: Name of the subpackage",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"pipeline": {
"description": "Optional: The list of pipelines that produce subpackage.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"range": {
"description": "Optional: The iterable used to generate multiple subpackages",
"type": "string"
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets"
},
"test": {
"$ref": "#/$defs/Test",
"description": "Test section for the subpackage."
},
"url": {
"description": "Optional: The URL to the package's homepage",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Test": {
"additionalProperties": false,
"properties": {
"environment": {
"$ref": "#/$defs/ImageConfiguration",
"description": "Additional Environment necessary for test.\nEnvironment.Contents.Packages automatically get\npackage.dependencies.runtime added to it. So, if your test needs\nno additional packages, you can leave it blank."
},
"pipeline": {
"description": "Required: The list of pipelines that test the produced package.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
}
},
"required": [
"environment",
"pipeline"
],
"type": "object"
},
"Trigger": {
"additionalProperties": false,
"properties": {
"paths": {
"description": "Optional: The list of paths to monitor to trigger the script",
"items": {
"type": "string"
},
"type": "array"
},
"script": {
"description": "Optional: The script to run",
"type": "string"
}
},
"type": "object"
},
"Update": {
"additionalProperties": false,
"description": "Update provides information used to describe how to keep the package up to date",
"properties": {
"enabled": {
"description": "Toggle if updates should occur",
"type": "boolean"
},
"github": {
"$ref": "#/$defs/GitHubMonitor",
"description": "The configuration block for updates tracked via the Github API"
},
"ignore-regex-patterns": {
"description": "A slice of regex patterns to match an upstream version and ignore",
"items": {
"type": "string"
},
"type": "array"
},
"manual": {
"description": "Indicates that this package should be manually updated, usually taking\ncare over special version numbers",
"type": "boolean"
},
"release-monitor": {
"$ref": "#/$defs/ReleaseMonitor",
"description": "The configuration block for updates tracked via release-monitoring.org"
},
"shared": {
"description": "Indicate that an update to this package requires an epoch bump of\ndownstream dependencies, e.g. golang, java",
"type": "boolean"
},
"version-separator": {
"description": "Override the version separator if it is nonstandard",
"type": "string"
},
"version-transform": {
"description": "The configuration block for transforming the `package.version` into an APK version",
"items": {
"$ref": "#/$defs/VersionTransform"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"User": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"uid": {
"type": "integer"
},
"username": {
"type": "string"
}
},
"type": "object"
},
"VarTransforms": {
"additionalProperties": false,
"properties": {
"from": {
"description": "Required: The original template variable.\n\nExample: ${{package.version}}",
"type": "string"
},
"match": {
"description": "Required: The regular expression to match against the `from` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
},
"to": {
"description": "Required: The name of the new variable to create\n\nExample: mangeled-package-version",
"type": "string"
}
},
"required": [
"from",
"match",
"replace",
"to"
],
"type": "object"
},
"VersionTransform": {
"additionalProperties": false,
"description": "VersionTransform allows mapping the package version to an APK version",
"properties": {
"match": {
"description": "Required: The regular expression to match against the `package.version` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
}
},
"required": [
"match",
"replace"
],
"type": "object"
}
},
"$id": "https://chainguard.dev/melange/pkg/config/configuration",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
chainguard-dev/melange | 3afae572946caa1f1c566fe50253e3a51bc7c8a8 | 2024-05-16T17:41:51 | pkg/config/schema.json | 367 | 2024-05-27T05:33:19.976056Z | {
"$defs": {
"BaseImageDescriptor": {
"additionalProperties": false,
"properties": {
"apkindex": {
"type": "string"
},
"image": {
"type": "string"
}
},
"type": "object"
},
"BuildOption": {
"additionalProperties": false,
"description": "BuildOption describes an optional deviation to a package build.",
"properties": {
"Environment": {
"$ref": "#/$defs/EnvironmentOption"
},
"Vars": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"required": [
"Vars",
"Environment"
],
"type": "object"
},
"Checks": {
"additionalProperties": false,
"properties": {
"disabled": {
"description": "Optional: disable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Optional: enable these linters that are not enabled by default.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "The root melange configuration",
"properties": {
"data": {
"description": "Optional: An arbitrary list of data that can be used via templating in the\npipeline",
"items": {
"$ref": "#/$defs/RangeData"
},
"type": "array"
},
"environment": {
"$ref": "#/$defs/ImageConfiguration",
"description": "The specification for the packages build environment"
},
"options": {
"additionalProperties": {
"$ref": "#/$defs/BuildOption"
},
"description": "Optional: Deviations to the build",
"type": "object"
},
"package": {
"$ref": "#/$defs/Package",
"description": "Package metadata"
},
"pipeline": {
"description": "Required: The list of pipelines that produce the package.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"subpackages": {
"description": "Optional: The list of subpackages that this package also produces.",
"items": {
"$ref": "#/$defs/Subpackage"
},
"type": "array"
},
"test": {
"$ref": "#/$defs/Test",
"description": "Test section for the main package."
},
"update": {
"$ref": "#/$defs/Update",
"description": "Optional: The update block determining how this package is auto updated"
},
"var-transforms": {
"description": "Optional: A list of transformations to create for the builtin template\nvariables",
"items": {
"$ref": "#/$defs/VarTransforms"
},
"type": "array"
},
"vars": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: A map of arbitrary variables that can be used via templating in\nthe pipeline",
"type": "object"
}
},
"required": [
"package",
"environment"
],
"type": "object"
},
"ContentsOption": {
"additionalProperties": false,
"description": "ContentsOption describes an optional deviation to an apko environment's contents block.",
"properties": {
"Packages": {
"$ref": "#/$defs/ListOption"
}
},
"required": [
"Packages"
],
"type": "object"
},
"Copyright": {
"additionalProperties": false,
"properties": {
"attestation": {
"description": "Optional: Attestations of the license",
"type": "string"
},
"license": {
"description": "Required: The license for this package",
"type": "string"
},
"license-path": {
"description": "Optional: Custom licenses to generate LicenseRefs from",
"type": "string"
},
"paths": {
"description": "Optional: The license paths, typically '*'",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"license"
],
"type": "object"
},
"DataItems": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Dependencies": {
"additionalProperties": false,
"properties": {
"provider-priority": {
"description": "Optional: An integer compared against other equal package provides used to\ndetermine priority",
"type": "integer"
},
"provides": {
"description": "Optional: List of packages provided",
"items": {
"type": "string"
},
"type": "array"
},
"replaces": {
"description": "Optional: List of replace objectives",
"items": {
"type": "string"
},
"type": "array"
},
"runtime": {
"description": "Optional: List of runtime dependencies",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"EnvironmentOption": {
"additionalProperties": false,
"description": "EnvironmentOption describes an optional deviation to an apko environment.",
"properties": {
"Contents": {
"$ref": "#/$defs/ContentsOption"
}
},
"required": [
"Contents"
],
"type": "object"
},
"GitHubMonitor": {
"additionalProperties": false,
"description": "GitHubMonitor indicates using the GitHub API",
"properties": {
"identifier": {
"description": "Org/repo for GitHub",
"type": "string"
},
"strip-prefix": {
"description": "If the version in GitHub contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in GitHub contains a suffix which should be ignored",
"type": "string"
},
"tag-filter": {
"description": "Filter to apply when searching tags on a GitHub repository\nDeprecated: Use TagFilterPrefix instead",
"type": "string"
},
"tag-filter-contains": {
"description": "Filter to apply when searching tags on a GitHub repository",
"type": "string"
},
"tag-filter-prefix": {
"description": "Prefix filter to apply when searching tags on a GitHub repository",
"type": "string"
},
"use-tag": {
"description": "Override the default of using a GitHub release to identify related tag to\nfetch. Not all projects use GitHub releases but just use tags",
"type": "boolean"
}
},
"required": [
"identifier"
],
"type": "object"
},
"Group": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"groupname": {
"type": "string"
},
"members": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageAccounts": {
"additionalProperties": false,
"properties": {
"groups": {
"items": {
"$ref": "#/$defs/Group"
},
"type": "array"
},
"run-as": {
"type": "string"
},
"users": {
"items": {
"$ref": "#/$defs/User"
},
"type": "array"
}
},
"type": "object"
},
"ImageConfiguration": {
"additionalProperties": false,
"properties": {
"accounts": {
"$ref": "#/$defs/ImageAccounts"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"archs": {
"items": {
"type": "string"
},
"type": "array"
},
"cmd": {
"type": "string"
},
"contents": {
"$ref": "#/$defs/ImageContents"
},
"entrypoint": {
"$ref": "#/$defs/ImageEntrypoint"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"include": {
"type": "string"
},
"os-release": {
"$ref": "#/$defs/OSRelease"
},
"paths": {
"items": {
"$ref": "#/$defs/PathMutation"
},
"type": "array"
},
"stop-signal": {
"type": "string"
},
"vcs-url": {
"type": "string"
},
"volumes": {
"items": {
"type": "string"
},
"type": "array"
},
"work-dir": {
"type": "string"
}
},
"type": "object"
},
"ImageContents": {
"additionalProperties": false,
"properties": {
"baseimage": {
"$ref": "#/$defs/BaseImageDescriptor"
},
"keyring": {
"items": {
"type": "string"
},
"type": "array"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"repositories": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageEntrypoint": {
"additionalProperties": false,
"properties": {
"command": {
"type": "string"
},
"services": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"shell-fragment": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"Input": {
"additionalProperties": false,
"properties": {
"default": {
"description": "Optional: The default value of the input. Required when the input is.",
"type": "string"
},
"description": {
"description": "Optional: The human readable description of the input",
"type": "string"
},
"required": {
"description": "Optional: A toggle denoting whether the input is required or not",
"type": "boolean"
}
},
"type": "object"
},
"ListOption": {
"additionalProperties": false,
"description": "ListOption describes an optional deviation to a list, for example, a list of packages.",
"properties": {
"Add": {
"items": {
"type": "string"
},
"type": "array"
},
"Remove": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Add",
"Remove"
],
"type": "object"
},
"Needs": {
"additionalProperties": false,
"properties": {
"Packages": {
"description": "A list of packages needed by this pipeline",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Packages"
],
"type": "object"
},
"OSRelease": {
"additionalProperties": false,
"properties": {
"bug-report-url": {
"type": "string"
},
"home-url": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"pretty-name": {
"type": "string"
},
"version-id": {
"type": "string"
}
},
"type": "object"
},
"Package": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the package build configuration",
"type": "string"
},
"copyright": {
"description": "The list of copyrights for this package",
"items": {
"$ref": "#/$defs/Copyright"
},
"type": "array"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "List of packages to depends on"
},
"description": {
"description": "A human readable description of the package",
"type": "string"
},
"epoch": {
"description": "The monotone increasing epoch of the package",
"type": "integer"
},
"name": {
"description": "The name of the package",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Optional: Resources to allocate to the build."
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets",
"description": "Optional: Executable scripts that run at various stages of the package\nlifecycle, triggered by configurable events"
},
"target-architecture": {
"description": "List of target architectures for which this package should be build for",
"items": {
"type": "string"
},
"type": "array"
},
"timeout": {
"description": "Optional: The amount of time to allow this build to take before timing out.",
"type": "integer"
},
"url": {
"description": "The URL to the package's homepage",
"type": "string"
},
"version": {
"description": "The version of the package",
"type": "string"
}
},
"required": [
"name",
"version",
"epoch"
],
"type": "object"
},
"PackageOption": {
"additionalProperties": false,
"properties": {
"no-commands": {
"description": "Optional: Mark this package as not providing any executables",
"type": "boolean"
},
"no-depends": {
"description": "Optional: Mark this package as a self contained package that does not\ndepend on any other package",
"type": "boolean"
},
"no-provides": {
"description": "Optional: Signify this package as a virtual package which does not provide\nany files, executables, libraries, etc... and is otherwise empty",
"type": "boolean"
}
},
"required": [
"no-provides",
"no-depends",
"no-commands"
],
"type": "object"
},
"PathMutation": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"path": {
"type": "string"
},
"permissions": {
"type": "integer"
},
"recursive": {
"type": "boolean"
},
"source": {
"type": "string"
},
"type": {
"type": "string"
},
"uid": {
"type": "integer"
}
},
"type": "object"
},
"Pipeline": {
"additionalProperties": false,
"properties": {
"assertions": {
"$ref": "#/$defs/PipelineAssertions",
"description": "Optional: Assertions to evaluate whether the pipeline was successful"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: environment variables to override the apko environment",
"type": "object"
},
"if": {
"description": "Optional: A condition to evaluate before running the pipeline",
"type": "string"
},
"inputs": {
"additionalProperties": {
"$ref": "#/$defs/Input"
},
"description": "Optional: A map of inputs to the pipeline",
"type": "object"
},
"label": {
"description": "Optional: Labels to apply to the pipeline",
"type": "string"
},
"name": {
"description": "Optional: A user defined name for the pipeline",
"type": "string"
},
"needs": {
"$ref": "#/$defs/Needs",
"description": "Optional: Configuration to determine any explicit dependencies this pipeline may have"
},
"pipeline": {
"description": "Optional: The list of pipelines to run.\n\nEach pipeline runs in it's own context that is not shared between other\npipelines. To share context between pipelines, nest a pipeline within an\nexisting pipeline. This can be useful when you wish to share common\nconfiguration, such as an alternative `working-directory`.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"runs": {
"description": "Optional: The command to run using the builder's shell (/bin/sh)",
"type": "string"
},
"uses": {
"description": "Optional: A named reusable pipeline to run\n\nThis can be either a pipeline builtin to melange, or a user defined named pipeline.\nFor example, to use a builtin melange pipeline:\n\t\tuses: autoconf/make",
"type": "string"
},
"with": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Arguments passed to the reusable pipelines defined in `uses`",
"type": "object"
},
"working-directory": {
"description": "Optional: The working directory of the pipeline\n\nThis defaults to the guests' build workspace (/home/build)",
"type": "string"
}
},
"type": "object"
},
"PipelineAssertions": {
"additionalProperties": false,
"properties": {
"required-steps": {
"description": "The number (an int) of required steps that must complete successfully\nwithin the asserted pipeline.",
"type": "integer"
}
},
"type": "object"
},
"RangeData": {
"additionalProperties": false,
"properties": {
"items": {
"$ref": "#/$defs/DataItems"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"items"
],
"type": "object"
},
"ReleaseMonitor": {
"additionalProperties": false,
"description": "ReleaseMonitor indicates using the API for https://release-monitoring.org/",
"properties": {
"identifier": {
"description": "Required: ID number for release monitor",
"type": "integer"
},
"strip-prefix": {
"description": "If the version in release monitor contains a prefix which should be ignored",
"type": "string"
},
"strip-suffix": {
"description": "If the version in release monitor contains a suffix which should be ignored",
"type": "string"
}
},
"required": [
"identifier"
],
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"Scriptlets": {
"additionalProperties": false,
"properties": {
"post-deinstall": {
"description": "Optional: The script to run after uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"post-install": {
"description": "Optional: The script to run post install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"post-upgrade": {
"description": "Optional: The script to run after upgrading. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-deinstall": {
"description": "Optional: The script to run before uninstalling. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"pre-install": {
"description": "Optional: The script to run pre install. The script should contain the\nshebang interpreter.",
"type": "string"
},
"pre-upgrade": {
"description": "Optional: The script to run before upgrading. The script should contain\nthe shebang interpreter.",
"type": "string"
},
"trigger": {
"$ref": "#/$defs/Trigger",
"description": "Optional: A script to run on a custom trigger"
}
},
"type": "object"
},
"Subpackage": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/Checks",
"description": "Optional: enabling, disabling, and configuration of build checks"
},
"commit": {
"description": "Optional: The git commit of the subpackage build configuration",
"type": "string"
},
"dependencies": {
"$ref": "#/$defs/Dependencies",
"description": "Optional: List of packages to depend on"
},
"description": {
"description": "Optional: The human readable description of the subpackage",
"type": "string"
},
"if": {
"description": "Optional: A conditional statement to evaluate for the subpackage",
"type": "string"
},
"name": {
"description": "Required: Name of the subpackage",
"type": "string"
},
"options": {
"$ref": "#/$defs/PackageOption",
"description": "Optional: Options that alter the packages behavior"
},
"pipeline": {
"description": "Optional: The list of pipelines that produce subpackage.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
},
"range": {
"description": "Optional: The iterable used to generate multiple subpackages",
"type": "string"
},
"scriptlets": {
"$ref": "#/$defs/Scriptlets"
},
"test": {
"$ref": "#/$defs/Test",
"description": "Test section for the subpackage."
},
"url": {
"description": "Optional: The URL to the package's homepage",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Test": {
"additionalProperties": false,
"properties": {
"environment": {
"$ref": "#/$defs/ImageConfiguration",
"description": "Additional Environment necessary for test.\nEnvironment.Contents.Packages automatically get\npackage.dependencies.runtime added to it. So, if your test needs\nno additional packages, you can leave it blank."
},
"pipeline": {
"description": "Required: The list of pipelines that test the produced package.",
"items": {
"$ref": "#/$defs/Pipeline"
},
"type": "array"
}
},
"required": [
"environment",
"pipeline"
],
"type": "object"
},
"Trigger": {
"additionalProperties": false,
"properties": {
"paths": {
"description": "Optional: The list of paths to monitor to trigger the script",
"items": {
"type": "string"
},
"type": "array"
},
"script": {
"description": "Optional: The script to run",
"type": "string"
}
},
"type": "object"
},
"Update": {
"additionalProperties": false,
"description": "Update provides information used to describe how to keep the package up to date",
"properties": {
"enabled": {
"description": "Toggle if updates should occur",
"type": "boolean"
},
"github": {
"$ref": "#/$defs/GitHubMonitor",
"description": "The configuration block for updates tracked via the Github API"
},
"ignore-regex-patterns": {
"description": "A slice of regex patterns to match an upstream version and ignore",
"items": {
"type": "string"
},
"type": "array"
},
"manual": {
"description": "Indicates that this package should be manually updated, usually taking\ncare over special version numbers",
"type": "boolean"
},
"release-monitor": {
"$ref": "#/$defs/ReleaseMonitor",
"description": "The configuration block for updates tracked via release-monitoring.org"
},
"shared": {
"description": "Indicate that an update to this package requires an epoch bump of\ndownstream dependencies, e.g. golang, java",
"type": "boolean"
},
"version-separator": {
"description": "Override the version separator if it is nonstandard",
"type": "string"
},
"version-transform": {
"description": "The configuration block for transforming the `package.version` into an APK version",
"items": {
"$ref": "#/$defs/VersionTransform"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"User": {
"additionalProperties": false,
"properties": {
"gid": {
"type": "integer"
},
"shell": {
"type": "string"
},
"uid": {
"type": "integer"
},
"username": {
"type": "string"
}
},
"type": "object"
},
"VarTransforms": {
"additionalProperties": false,
"properties": {
"from": {
"description": "Required: The original template variable.\n\nExample: ${{package.version}}",
"type": "string"
},
"match": {
"description": "Required: The regular expression to match against the `from` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
},
"to": {
"description": "Required: The name of the new variable to create\n\nExample: mangeled-package-version",
"type": "string"
}
},
"required": [
"from",
"match",
"replace",
"to"
],
"type": "object"
},
"VersionTransform": {
"additionalProperties": false,
"description": "VersionTransform allows mapping the package version to an APK version",
"properties": {
"match": {
"description": "Required: The regular expression to match against the `package.version` variable",
"type": "string"
},
"replace": {
"description": "Required: The repl to replace on all `match` matches",
"type": "string"
}
},
"required": [
"match",
"replace"
],
"type": "object"
}
},
"$id": "https://chainguard.dev/melange/pkg/config/configuration",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
chainguard-dev/apko | 121b4248d0be7a35529be814e86268072aeda568 | 2024-04-22T16:53:56 | pkg/build/types/schema.json | 1,087 | 2024-05-27T08:11:26.087947Z | {
"$defs": {
"BaseImageDescriptor": {
"additionalProperties": false,
"properties": {
"apkindex": {
"description": "Required: Path to file representing installed packages in the base image in APKINDEX format.\n(Assumes regular Alpine repository layout, that is: set /foo/bar if the index is /foo/bor/{aarch64|x86_64}/APKINDEX",
"type": "string"
},
"image": {
"description": "Required: Path to the base image OCI layout. Right now only local files are supported.",
"type": "string"
}
},
"type": "object"
},
"Group": {
"additionalProperties": false,
"properties": {
"gid": {
"description": "Required: The group ID",
"type": "integer"
},
"groupname": {
"description": "Required: The name of the group",
"type": "string"
},
"members": {
"description": "Required: The list of members of the group",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageAccounts": {
"additionalProperties": false,
"properties": {
"groups": {
"description": "Required: List of groups to populate the image with",
"items": {
"$ref": "#/$defs/Group"
},
"type": "array"
},
"run-as": {
"description": "Required: The user to run the container as. This can be a username or UID.",
"type": "string"
},
"users": {
"description": "Required: List of users to populate the image with",
"items": {
"$ref": "#/$defs/User"
},
"type": "array"
}
},
"type": "object"
},
"ImageConfiguration": {
"additionalProperties": false,
"properties": {
"accounts": {
"$ref": "#/$defs/ImageAccounts",
"description": "Optional: Account configuration for the container image"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Annotations to apply to the images manifests",
"type": "object"
},
"archs": {
"description": "Optional: List of CPU architectures to build the container image for\n\nThe list of supported architectures is: 386, amd64, arm64, arm/v6, arm/v7, ppc64le, riscv64, s390x",
"items": {
"type": "string"
},
"type": "array"
},
"cmd": {
"description": "Optional: The command of the container image\n\nThese are the additional arguments to pass to the entrypoint.",
"type": "string"
},
"contents": {
"$ref": "#/$defs/ImageContents",
"description": "Required: The apk packages in the container image"
},
"entrypoint": {
"$ref": "#/$defs/ImageEntrypoint",
"description": "Required: The entrypoint of the container image\n\nThis typically is the path to the executable to run. Since many of\nimages do not include a shell, this should be the full path\nto the executable."
},
"environment": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Envionment variables to set in the container image",
"type": "object"
},
"include": {
"description": "Optional: Path to a local file containing additional image configuration\n\nThe included configuration is deep merged with the parent configuration",
"type": "string"
},
"os-release": {
"$ref": "#/$defs/OSRelease",
"description": "Optional: The /etc/os-release configuration for the container image"
},
"paths": {
"description": "Optional: List of paths mutations",
"items": {
"$ref": "#/$defs/PathMutation"
},
"type": "array"
},
"stop-signal": {
"description": "Optional: The stop signal used to suspend the execution of the containers process",
"type": "string"
},
"vcs-url": {
"description": "Optional: The link to version control system for this container's source code",
"type": "string"
},
"volumes": {
"description": "Optional: A list of volumes to configure\n\nThis is _not_ the same as Paths, but refers to the OCI spec \"volumes\"\nfield used by some container runtimes (docker) to create volumes at\nruntime. For most use cases, this is not needed, but consider using this\nwhen the image requires special volume configuration at runtime for\nsupported container runtimes.",
"items": {
"type": "string"
},
"type": "array"
},
"work-dir": {
"description": "Optional: The working directory of the container",
"type": "string"
}
},
"type": "object"
},
"ImageContents": {
"additionalProperties": false,
"properties": {
"baseimage": {
"$ref": "#/$defs/BaseImageDescriptor",
"description": "Optional: Base image to build on top of. Warning: Experimental."
},
"keyring": {
"description": "A list of public keys used to verify the desired repositories",
"items": {
"type": "string"
},
"type": "array"
},
"packages": {
"description": "A list of packages to include in the image",
"items": {
"type": "string"
},
"type": "array"
},
"repositories": {
"description": "A list of apk repositories to use for pulling packages",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageEntrypoint": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Required: The command of the entrypoint",
"type": "string"
},
"services": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"shell-fragment": {
"description": "Optional: The shell fragment of the entrypoint command",
"type": "string"
},
"type": {
"description": "Optional: The type of entrypoint. Only \"service-bundle\" is supported.",
"type": "string"
}
},
"type": "object"
},
"OSRelease": {
"additionalProperties": false,
"properties": {
"bug-report-url": {
"description": "Optional: The URL of the bug reporting website for the OS",
"type": "string"
},
"home-url": {
"description": "Optional: The URL of the homepage for the OS",
"type": "string"
},
"id": {
"description": "Optional: The unique identifier for the OS",
"type": "string"
},
"name": {
"description": "Optional: The name of the OS",
"type": "string"
},
"pretty-name": {
"description": "Optional: The human readable description of the OS",
"type": "string"
},
"version-id": {
"description": "Optional: The unique identifier for the version of the OS",
"type": "string"
}
},
"type": "object"
},
"PathMutation": {
"additionalProperties": false,
"properties": {
"gid": {
"description": "The mutation's desired group ID",
"type": "integer"
},
"path": {
"description": "The target path to mutate",
"type": "string"
},
"permissions": {
"description": "The permission bits for the path",
"type": "integer"
},
"recursive": {
"description": "Toggle whether to mutate recursively",
"type": "boolean"
},
"source": {
"description": "The source path to mutate",
"type": "string"
},
"type": {
"description": "The type of mutation to perform\n\nThis can be one of: directory, empty-file, hardlink, symlink, permissions",
"type": "string"
},
"uid": {
"description": "The mutation's desired user ID",
"type": "integer"
}
},
"type": "object"
},
"User": {
"additionalProperties": false,
"properties": {
"gid": {
"description": "Required: The user's group ID",
"type": "integer"
},
"shell": {
"description": "Required: The user's shell",
"type": "string"
},
"uid": {
"description": "Required: The user ID",
"type": "integer"
},
"username": {
"description": "Required: The name of the user",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://chainguard.dev/apko/pkg/build/types/image-configuration",
"$ref": "#/$defs/ImageConfiguration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
chainguard-dev/apko | f68a2c19f25408bf0c065c4459b24baf512f5589 | 2024-01-11T15:32:53 | pkg/build/types/schema.json | 1,087 | 2024-05-27T08:11:26.087947Z | {
"$defs": {
"Group": {
"additionalProperties": false,
"properties": {
"gid": {
"description": "Required: The group ID",
"type": "integer"
},
"groupname": {
"description": "Required: The name of the group",
"type": "string"
},
"members": {
"description": "Required: The list of members of the group",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageAccounts": {
"additionalProperties": false,
"properties": {
"groups": {
"description": "Required: List of groups to populate the image with",
"items": {
"$ref": "#/$defs/Group"
},
"type": "array"
},
"run-as": {
"description": "Required: The user to run the container as. This can be a username or UID.",
"type": "string"
},
"users": {
"description": "Required: List of users to populate the image with",
"items": {
"$ref": "#/$defs/User"
},
"type": "array"
}
},
"type": "object"
},
"ImageConfiguration": {
"additionalProperties": false,
"properties": {
"accounts": {
"$ref": "#/$defs/ImageAccounts",
"description": "Optional: Account configuration for the container image"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Annotations to apply to the images manifests",
"type": "object"
},
"archs": {
"description": "Optional: List of CPU architectures to build the container image for\n\nThe list of supported architectures is: 386, amd64, arm64, arm/v6, arm/v7, ppc64le, riscv64, s390x",
"items": {
"type": "string"
},
"type": "array"
},
"cmd": {
"description": "Optional: The command of the container image\n\nThese are the additional arguments to pass to the entrypoint.",
"type": "string"
},
"contents": {
"$ref": "#/$defs/ImageContents",
"description": "Required: The apk packages in the container image"
},
"entrypoint": {
"$ref": "#/$defs/ImageEntrypoint",
"description": "Required: The entrypoint of the container image\n\nThis typically is the path to the executable to run. Since many of\nimages do not include a shell, this should be the full path\nto the executable."
},
"environment": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Envionment variables to set in the container image",
"type": "object"
},
"include": {
"description": "Optional: Path to a local file containing additional image configuration\n\nThe included configuration is deep merged with the parent configuration",
"type": "string"
},
"os-release": {
"$ref": "#/$defs/OSRelease",
"description": "Optional: The /etc/os-release configuration for the container image"
},
"paths": {
"description": "Optional: List of paths mutations",
"items": {
"$ref": "#/$defs/PathMutation"
},
"type": "array"
},
"stop-signal": {
"description": "Optional: The stop signal used to suspend the execution of the containers process",
"type": "string"
},
"vcs-url": {
"description": "Optional: The link to version control system for this container's source code",
"type": "string"
},
"volumes": {
"description": "Optional: A list of volumes to configure\n\nThis is _not_ the same as Paths, but refers to the OCI spec \"volumes\"\nfield used by some container runtimes (docker) to create volumes at\nruntime. For most use cases, this is not needed, but consider using this\nwhen the image requires special volume configuration at runtime for\nsupported container runtimes.",
"items": {
"type": "string"
},
"type": "array"
},
"work-dir": {
"description": "Optional: The working directory of the container",
"type": "string"
}
},
"type": "object"
},
"ImageContents": {
"additionalProperties": false,
"properties": {
"keyring": {
"description": "A list of public keys used to verify the desired repositories",
"items": {
"type": "string"
},
"type": "array"
},
"packages": {
"description": "A list of packages to include in the image",
"items": {
"type": "string"
},
"type": "array"
},
"repositories": {
"description": "A list of apk repositories to use for pulling packages",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageEntrypoint": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Required: The command of the entrypoint",
"type": "string"
},
"services": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"shell-fragment": {
"description": "Optional: The shell fragment of the entrypoint command",
"type": "string"
},
"type": {
"description": "Optional: The type of entrypoint. Only \"service-bundle\" is supported.",
"type": "string"
}
},
"type": "object"
},
"OSRelease": {
"additionalProperties": false,
"properties": {
"bug-report-url": {
"description": "Optional: The URL of the bug reporting website for the OS",
"type": "string"
},
"home-url": {
"description": "Optional: The URL of the homepage for the OS",
"type": "string"
},
"id": {
"description": "Optional: The unique identifier for the OS",
"type": "string"
},
"name": {
"description": "Optional: The name of the OS",
"type": "string"
},
"pretty-name": {
"description": "Optional: The human readable description of the OS",
"type": "string"
},
"version-id": {
"description": "Optional: The unique identifier for the version of the OS",
"type": "string"
}
},
"type": "object"
},
"PathMutation": {
"additionalProperties": false,
"properties": {
"gid": {
"description": "The mutation's desired group ID",
"type": "integer"
},
"path": {
"description": "The target path to mutate",
"type": "string"
},
"permissions": {
"description": "The permission bits for the path",
"type": "integer"
},
"recursive": {
"description": "Toggle whether to mutate recursively",
"type": "boolean"
},
"source": {
"description": "The source path to mutate",
"type": "string"
},
"type": {
"description": "The type of mutation to perform\n\nThis can be one of: directory, empty-file, hardlink, symlink, permissions",
"type": "string"
},
"uid": {
"description": "The mutation's desired user ID",
"type": "integer"
}
},
"type": "object"
},
"User": {
"additionalProperties": false,
"properties": {
"gid": {
"description": "Required: The user's group ID",
"type": "integer"
},
"uid": {
"description": "Required: The user ID",
"type": "integer"
},
"username": {
"description": "Required: The name of the user",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://chainguard.dev/apko/pkg/build/types/image-configuration",
"$ref": "#/$defs/ImageConfiguration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
chainguard-dev/apko | 88e61941f980b48e114992154eaa3412fb42f80e | 2023-11-20T17:51:21 | pkg/build/types/schema.json | 1,087 | 2024-05-27T08:11:26.087947Z | {
"$defs": {
"AccountsOption": {
"additionalProperties": false,
"description": "AccountsOption describes an optional deviation to an apko environment's run-as setting.",
"properties": {
"RunAs": {
"type": "string"
}
},
"required": [
"RunAs"
],
"type": "object"
},
"BuildOption": {
"additionalProperties": false,
"description": "BuildOption describes an optional deviation to an apko environment.",
"properties": {
"Accounts": {
"$ref": "#/$defs/AccountsOption"
},
"Contents": {
"$ref": "#/$defs/ContentsOption"
},
"Entrypoint": {
"$ref": "#/$defs/ImageEntrypoint"
},
"Environment": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"required": [
"Contents",
"Accounts",
"Environment",
"Entrypoint"
],
"type": "object"
},
"ContentsOption": {
"additionalProperties": false,
"description": "ContentsOption describes an optional deviation to an apko environment's contents block.",
"properties": {
"Packages": {
"$ref": "#/$defs/ListOption"
}
},
"required": [
"Packages"
],
"type": "object"
},
"Group": {
"additionalProperties": false,
"properties": {
"gid": {
"description": "Required: The group ID",
"type": "integer"
},
"groupname": {
"description": "Required: The name of the group",
"type": "string"
},
"members": {
"description": "Required: The list of members of the group",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageAccounts": {
"additionalProperties": false,
"properties": {
"groups": {
"description": "Required: List of groups to populate the image with",
"items": {
"$ref": "#/$defs/Group"
},
"type": "array"
},
"run-as": {
"description": "Required: The user to run the container as. This can be a username or UID.",
"type": "string"
},
"users": {
"description": "Required: List of users to populate the image with",
"items": {
"$ref": "#/$defs/User"
},
"type": "array"
}
},
"type": "object"
},
"ImageConfiguration": {
"additionalProperties": false,
"properties": {
"accounts": {
"$ref": "#/$defs/ImageAccounts",
"description": "Optional: Account configuration for the container image"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Annotations to apply to the images manifests",
"type": "object"
},
"archs": {
"description": "Optional: List of CPU architectures to build the container image for\n\nThe list of supported architectures is: 386, amd64, arm64, arm/v6, arm/v7, ppc64le, riscv64, s390x",
"items": {
"type": "string"
},
"type": "array"
},
"cmd": {
"description": "Optional: The command of the container image\n\nThese are the additional arguments to pass to the entrypoint.",
"type": "string"
},
"contents": {
"$ref": "#/$defs/ImageContents",
"description": "Required: The apk packages in the container image"
},
"entrypoint": {
"$ref": "#/$defs/ImageEntrypoint",
"description": "Required: The entrypoint of the container image\n\nThis typically is the path to the executable to run. Since many of\nimages do not include a shell, this should be the full path\nto the executable."
},
"environment": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Envionment variables to set in the container image",
"type": "object"
},
"include": {
"description": "Optional: Path to a local file containing additional image configuration\n\nThe included configuration is deep merged with the parent configuration",
"type": "string"
},
"options": {
"additionalProperties": {
"$ref": "#/$defs/BuildOption"
},
"description": "Optional: A map of named build option deviations\n\nDeprecated: Use WithExtraPackages.",
"type": "object"
},
"os-release": {
"$ref": "#/$defs/OSRelease",
"description": "Optional: The /etc/os-release configuration for the container image"
},
"paths": {
"description": "Optional: List of paths mutations",
"items": {
"$ref": "#/$defs/PathMutation"
},
"type": "array"
},
"stop-signal": {
"description": "Optional: The stop signal used to suspend the execution of the containers process",
"type": "string"
},
"vcs-url": {
"description": "Optional: The link to version control system for this container's source code",
"type": "string"
},
"volumes": {
"description": "Optional: A list of volumes to configure\n\nThis is _not_ the same as Paths, but refers to the OCI spec \"volumes\"\nfield used by some container runtimes (docker) to create volumes at\nruntime. For most use cases, this is not needed, but consider using this\nwhen the image requires special volume configuration at runtime for\nsupported container runtimes.",
"items": {
"type": "string"
},
"type": "array"
},
"work-dir": {
"description": "Optional: The working directory of the container",
"type": "string"
}
},
"type": "object"
},
"ImageContents": {
"additionalProperties": false,
"properties": {
"keyring": {
"description": "A list of public keys used to verify the desired repositories",
"items": {
"type": "string"
},
"type": "array"
},
"packages": {
"description": "A list of packages to include in the image",
"items": {
"type": "string"
},
"type": "array"
},
"repositories": {
"description": "A list of apk repositories to use for pulling packages",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageEntrypoint": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Required: The command of the entrypoint",
"type": "string"
},
"services": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"shell-fragment": {
"description": "Optional: The shell fragment of the entrypoint command",
"type": "string"
},
"type": {
"description": "Optional: The type of entrypoint. Only \"service-bundle\" is supported.",
"type": "string"
}
},
"type": "object"
},
"ListOption": {
"additionalProperties": false,
"description": "ListOption describes an optional deviation to a list, for example, a list of packages.",
"properties": {
"Add": {
"items": {
"type": "string"
},
"type": "array"
},
"Remove": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Add",
"Remove"
],
"type": "object"
},
"OSRelease": {
"additionalProperties": false,
"properties": {
"bug-report-url": {
"description": "Optional: The URL of the bug reporting website for the OS",
"type": "string"
},
"home-url": {
"description": "Optional: The URL of the homepage for the OS",
"type": "string"
},
"id": {
"description": "Optional: The unique identifier for the OS",
"type": "string"
},
"name": {
"description": "Optional: The name of the OS",
"type": "string"
},
"pretty-name": {
"description": "Optional: The human readable description of the OS",
"type": "string"
},
"version-id": {
"description": "Optional: The unique identifier for the version of the OS",
"type": "string"
}
},
"type": "object"
},
"PathMutation": {
"additionalProperties": false,
"properties": {
"gid": {
"description": "The mutation's desired group ID",
"type": "integer"
},
"path": {
"description": "The target path to mutate",
"type": "string"
},
"permissions": {
"description": "The permission bits for the path",
"type": "integer"
},
"recursive": {
"description": "Toggle whether to mutate recursively",
"type": "boolean"
},
"source": {
"description": "The source path to mutate",
"type": "string"
},
"type": {
"description": "The type of mutation to perform\n\nThis can be one of: directory, empty-file, hardlink, symlink, permissions",
"type": "string"
},
"uid": {
"description": "The mutation's desired user ID",
"type": "integer"
}
},
"type": "object"
},
"User": {
"additionalProperties": false,
"properties": {
"gid": {
"description": "Required: The user's group ID",
"type": "integer"
},
"uid": {
"description": "Required: The user ID",
"type": "integer"
},
"username": {
"description": "Required: The name of the user",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://chainguard.dev/apko/pkg/build/types/image-configuration",
"$ref": "#/$defs/ImageConfiguration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
chainguard-dev/apko | 691011999e011b3a13106fe44a27279f632dce94 | 2024-04-22T06:00:11 | pkg/build/types/schema.json | 1,087 | 2024-05-27T08:11:26.087947Z | {
"$defs": {
"BaseImageDescriptor": {
"additionalProperties": false,
"properties": {
"apkindex": {
"description": "Required: Path to file representing installed packages in the base image in APKINDEX format.\n(Assumes regular Alpine repository layout, that is: set /foo/bar if the index is /foo/bor/{aarch64|x86_64}/APKINDEX",
"type": "string"
},
"image": {
"description": "Required: Path to the base image OCI layout. Right now only local files are supported.",
"type": "string"
}
},
"type": "object"
},
"Group": {
"additionalProperties": false,
"properties": {
"gid": {
"description": "Required: The group ID",
"type": "integer"
},
"groupname": {
"description": "Required: The name of the group",
"type": "string"
},
"members": {
"description": "Required: The list of members of the group",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageAccounts": {
"additionalProperties": false,
"properties": {
"groups": {
"description": "Required: List of groups to populate the image with",
"items": {
"$ref": "#/$defs/Group"
},
"type": "array"
},
"run-as": {
"description": "Required: The user to run the container as. This can be a username or UID.",
"type": "string"
},
"users": {
"description": "Required: List of users to populate the image with",
"items": {
"$ref": "#/$defs/User"
},
"type": "array"
}
},
"type": "object"
},
"ImageConfiguration": {
"additionalProperties": false,
"properties": {
"accounts": {
"$ref": "#/$defs/ImageAccounts",
"description": "Optional: Account configuration for the container image"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Annotations to apply to the images manifests",
"type": "object"
},
"archs": {
"description": "Optional: List of CPU architectures to build the container image for\n\nThe list of supported architectures is: 386, amd64, arm64, arm/v6, arm/v7, ppc64le, riscv64, s390x",
"items": {
"type": "string"
},
"type": "array"
},
"cmd": {
"description": "Optional: The command of the container image\n\nThese are the additional arguments to pass to the entrypoint.",
"type": "string"
},
"contents": {
"$ref": "#/$defs/ImageContents",
"description": "Required: The apk packages in the container image"
},
"entrypoint": {
"$ref": "#/$defs/ImageEntrypoint",
"description": "Required: The entrypoint of the container image\n\nThis typically is the path to the executable to run. Since many of\nimages do not include a shell, this should be the full path\nto the executable."
},
"environment": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Envionment variables to set in the container image",
"type": "object"
},
"include": {
"description": "Optional: Path to a local file containing additional image configuration\n\nThe included configuration is deep merged with the parent configuration",
"type": "string"
},
"os-release": {
"$ref": "#/$defs/OSRelease",
"description": "Optional: The /etc/os-release configuration for the container image"
},
"paths": {
"description": "Optional: List of paths mutations",
"items": {
"$ref": "#/$defs/PathMutation"
},
"type": "array"
},
"stop-signal": {
"description": "Optional: The stop signal used to suspend the execution of the containers process",
"type": "string"
},
"vcs-url": {
"description": "Optional: The link to version control system for this container's source code",
"type": "string"
},
"volumes": {
"description": "Optional: A list of volumes to configure\n\nThis is _not_ the same as Paths, but refers to the OCI spec \"volumes\"\nfield used by some container runtimes (docker) to create volumes at\nruntime. For most use cases, this is not needed, but consider using this\nwhen the image requires special volume configuration at runtime for\nsupported container runtimes.",
"items": {
"type": "string"
},
"type": "array"
},
"work-dir": {
"description": "Optional: The working directory of the container",
"type": "string"
}
},
"type": "object"
},
"ImageContents": {
"additionalProperties": false,
"properties": {
"baseimage": {
"$ref": "#/$defs/BaseImageDescriptor",
"description": "Optional: Base image to build on top of. Warning: Experimental."
},
"keyring": {
"description": "A list of public keys used to verify the desired repositories",
"items": {
"type": "string"
},
"type": "array"
},
"packages": {
"description": "A list of packages to include in the image",
"items": {
"type": "string"
},
"type": "array"
},
"repositories": {
"description": "A list of apk repositories to use for pulling packages",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageEntrypoint": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Required: The command of the entrypoint",
"type": "string"
},
"services": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"shell-fragment": {
"description": "Optional: The shell fragment of the entrypoint command",
"type": "string"
},
"type": {
"description": "Optional: The type of entrypoint. Only \"service-bundle\" is supported.",
"type": "string"
}
},
"type": "object"
},
"OSRelease": {
"additionalProperties": false,
"properties": {
"bug-report-url": {
"description": "Optional: The URL of the bug reporting website for the OS",
"type": "string"
},
"home-url": {
"description": "Optional: The URL of the homepage for the OS",
"type": "string"
},
"id": {
"description": "Optional: The unique identifier for the OS",
"type": "string"
},
"name": {
"description": "Optional: The name of the OS",
"type": "string"
},
"pretty-name": {
"description": "Optional: The human readable description of the OS",
"type": "string"
},
"version-id": {
"description": "Optional: The unique identifier for the version of the OS",
"type": "string"
}
},
"type": "object"
},
"PathMutation": {
"additionalProperties": false,
"properties": {
"gid": {
"description": "The mutation's desired group ID",
"type": "integer"
},
"path": {
"description": "The target path to mutate",
"type": "string"
},
"permissions": {
"description": "The permission bits for the path",
"type": "integer"
},
"recursive": {
"description": "Toggle whether to mutate recursively",
"type": "boolean"
},
"source": {
"description": "The source path to mutate",
"type": "string"
},
"type": {
"description": "The type of mutation to perform\n\nThis can be one of: directory, empty-file, hardlink, symlink, permissions",
"type": "string"
},
"uid": {
"description": "The mutation's desired user ID",
"type": "integer"
}
},
"type": "object"
},
"User": {
"additionalProperties": false,
"properties": {
"gid": {
"description": "Required: The user's group ID",
"type": "integer"
},
"uid": {
"description": "Required: The user ID",
"type": "integer"
},
"username": {
"description": "Required: The name of the user",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://chainguard.dev/apko/pkg/build/types/image-configuration",
"$ref": "#/$defs/ImageConfiguration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
chainguard-dev/apko | 7c57cd6281e0b930438aefb42fe054a305400a60 | 2024-04-22T01:38:26 | pkg/build/types/schema.json | 1,087 | 2024-05-27T08:11:26.087947Z | {
"$defs": {
"Group": {
"additionalProperties": false,
"properties": {
"gid": {
"description": "Required: The group ID",
"type": "integer"
},
"groupname": {
"description": "Required: The name of the group",
"type": "string"
},
"members": {
"description": "Required: The list of members of the group",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageAccounts": {
"additionalProperties": false,
"properties": {
"groups": {
"description": "Required: List of groups to populate the image with",
"items": {
"$ref": "#/$defs/Group"
},
"type": "array"
},
"run-as": {
"description": "Required: The user to run the container as. This can be a username or UID.",
"type": "string"
},
"users": {
"description": "Required: List of users to populate the image with",
"items": {
"$ref": "#/$defs/User"
},
"type": "array"
}
},
"type": "object"
},
"ImageConfiguration": {
"additionalProperties": false,
"properties": {
"accounts": {
"$ref": "#/$defs/ImageAccounts",
"description": "Optional: Account configuration for the container image"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Annotations to apply to the images manifests",
"type": "object"
},
"archs": {
"description": "Optional: List of CPU architectures to build the container image for\n\nThe list of supported architectures is: 386, amd64, arm64, arm/v6, arm/v7, ppc64le, riscv64, s390x",
"items": {
"type": "string"
},
"type": "array"
},
"cmd": {
"description": "Optional: The command of the container image\n\nThese are the additional arguments to pass to the entrypoint.",
"type": "string"
},
"contents": {
"$ref": "#/$defs/ImageContents",
"description": "Required: The apk packages in the container image"
},
"entrypoint": {
"$ref": "#/$defs/ImageEntrypoint",
"description": "Required: The entrypoint of the container image\n\nThis typically is the path to the executable to run. Since many of\nimages do not include a shell, this should be the full path\nto the executable."
},
"environment": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Envionment variables to set in the container image",
"type": "object"
},
"include": {
"description": "Optional: Path to a local file containing additional image configuration\n\nThe included configuration is deep merged with the parent configuration",
"type": "string"
},
"os-release": {
"$ref": "#/$defs/OSRelease",
"description": "Optional: The /etc/os-release configuration for the container image"
},
"paths": {
"description": "Optional: List of paths mutations",
"items": {
"$ref": "#/$defs/PathMutation"
},
"type": "array"
},
"stop-signal": {
"description": "Optional: The stop signal used to suspend the execution of the containers process",
"type": "string"
},
"vcs-url": {
"description": "Optional: The link to version control system for this container's source code",
"type": "string"
},
"volumes": {
"description": "Optional: A list of volumes to configure\n\nThis is _not_ the same as Paths, but refers to the OCI spec \"volumes\"\nfield used by some container runtimes (docker) to create volumes at\nruntime. For most use cases, this is not needed, but consider using this\nwhen the image requires special volume configuration at runtime for\nsupported container runtimes.",
"items": {
"type": "string"
},
"type": "array"
},
"work-dir": {
"description": "Optional: The working directory of the container",
"type": "string"
}
},
"type": "object"
},
"ImageContents": {
"additionalProperties": false,
"properties": {
"keyring": {
"description": "A list of public keys used to verify the desired repositories",
"items": {
"type": "string"
},
"type": "array"
},
"packages": {
"description": "A list of packages to include in the image",
"items": {
"type": "string"
},
"type": "array"
},
"repositories": {
"description": "A list of apk repositories to use for pulling packages",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageEntrypoint": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Required: The command of the entrypoint",
"type": "string"
},
"services": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"shell-fragment": {
"description": "Optional: The shell fragment of the entrypoint command",
"type": "string"
},
"type": {
"description": "Optional: The type of entrypoint. Only \"service-bundle\" is supported.",
"type": "string"
}
},
"type": "object"
},
"OSRelease": {
"additionalProperties": false,
"properties": {
"bug-report-url": {
"description": "Optional: The URL of the bug reporting website for the OS",
"type": "string"
},
"home-url": {
"description": "Optional: The URL of the homepage for the OS",
"type": "string"
},
"id": {
"description": "Optional: The unique identifier for the OS",
"type": "string"
},
"name": {
"description": "Optional: The name of the OS",
"type": "string"
},
"pretty-name": {
"description": "Optional: The human readable description of the OS",
"type": "string"
},
"version-id": {
"description": "Optional: The unique identifier for the version of the OS",
"type": "string"
}
},
"type": "object"
},
"PathMutation": {
"additionalProperties": false,
"properties": {
"gid": {
"description": "The mutation's desired group ID",
"type": "integer"
},
"path": {
"description": "The target path to mutate",
"type": "string"
},
"permissions": {
"description": "The permission bits for the path",
"type": "integer"
},
"recursive": {
"description": "Toggle whether to mutate recursively",
"type": "boolean"
},
"source": {
"description": "The source path to mutate",
"type": "string"
},
"type": {
"description": "The type of mutation to perform\n\nThis can be one of: directory, empty-file, hardlink, symlink, permissions",
"type": "string"
},
"uid": {
"description": "The mutation's desired user ID",
"type": "integer"
}
},
"type": "object"
},
"User": {
"additionalProperties": false,
"properties": {
"gid": {
"description": "Required: The user's group ID",
"type": "integer"
},
"shell": {
"description": "Required: The user's shell",
"type": "string"
},
"uid": {
"description": "Required: The user ID",
"type": "integer"
},
"username": {
"description": "Required: The name of the user",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://chainguard.dev/apko/pkg/build/types/image-configuration",
"$ref": "#/$defs/ImageConfiguration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
psastras/sbom-rs | 258411a5cee5bf53793ee2ffab802221e1ea8604 | 2023-07-10T13:19:15 | serde-spdx/schemas/spdx_2_3.json | 17 | 2024-05-27T04:19:42.152995Z | {
"$id": "http://spdx.org/rdf/terms/2.3",
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"properties": {
"SPDXID": {
"description": "Uniquely identify any element in an SPDX document which may be referenced by other elements.",
"type": "string"
},
"annotations": {
"description": "Provide additional information about an SpdxElement.",
"items": {
"additionalProperties": false,
"description": "An Annotation is a comment on an SpdxItem by an agent.",
"properties": {
"annotationDate": {
"description": "Identify when the comment was made. This is to be specified according to the combined date and time in the UTC format, as specified in the ISO 8601 standard.",
"type": "string"
},
"annotationType": {
"description": "Type of the annotation.",
"enum": [
"OTHER",
"REVIEW"
],
"type": "string"
},
"annotator": {
"description": "This field identifies the person, organization, or tool that has commented on a file, package, snippet, or the entire document.",
"type": "string"
},
"comment": {
"type": "string"
}
},
"required": [
"annotationDate",
"annotationType",
"annotator",
"comment"
],
"type": "object"
},
"type": "array"
},
"comment": {
"type": "string"
},
"creationInfo": {
"additionalProperties": false,
"description": "One instance is required for each SPDX file produced. It provides the necessary information for forward and backward compatibility for processing tools.",
"properties": {
"comment": {
"type": "string"
},
"created": {
"description": "Identify when the SPDX document was originally created. The date is to be specified according to combined date and time in UTC format as specified in ISO 8601 standard.",
"type": "string"
},
"creators": {
"description": "Identify who (or what, in the case of a tool) created the SPDX document. If the SPDX document was created by an individual, indicate the person's name. If the SPDX document was created on behalf of a company or organization, indicate the entity name. If the SPDX document was created using a software tool, indicate the name and version for that tool. If multiple participants or tools were involved, use multiple instances of this field. Person name or organization name may be designated as \u201canonymous\u201d if appropriate.",
"items": {
"description": "Identify who (or what, in the case of a tool) created the SPDX document. If the SPDX document was created by an individual, indicate the person's name. If the SPDX document was created on behalf of a company or organization, indicate the entity name. If the SPDX document was created using a software tool, indicate the name and version for that tool. If multiple participants or tools were involved, use multiple instances of this field. Person name or organization name may be designated as \u201canonymous\u201d if appropriate.",
"type": "string"
},
"minItems": 1,
"type": "array"
},
"licenseListVersion": {
"description": "An optional field for creators of the SPDX file to provide the version of the SPDX License List used when the SPDX file was created.",
"type": "string"
}
},
"required": [
"created",
"creators"
],
"type": "object"
},
"dataLicense": {
"description": "License expression for dataLicense. See SPDX Annex D for the license expression syntax. Compliance with the SPDX specification includes populating the SPDX fields therein with data related to such fields (\"SPDX-Metadata\"). The SPDX specification contains numerous fields where an SPDX document creator may provide relevant explanatory text in SPDX-Metadata. Without opining on the lawfulness of \"database rights\" (in jurisdictions where applicable), such explanatory text is copyrightable subject matter in most Berne Convention countries. By using the SPDX specification, or any portion hereof, you hereby agree that any copyright rights (as determined by your jurisdiction) in any SPDX-Metadata, including without limitation explanatory text, shall be subject to the terms of the Creative Commons CC0 1.0 Universal license. For SPDX-Metadata not containing any copyright rights, you hereby agree and acknowledge that the SPDX-Metadata is provided to you \"as-is\" and without any representations or warranties of any kind concerning the SPDX-Metadata, express, implied, statutory or otherwise, including without limitation warranties of title, merchantability, fitness for a particular purpose, non-infringement, or the absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not discoverable, all to the greatest extent permissible under applicable law.",
"type": "string"
},
"documentDescribes": {
"$comment": "This field has been deprecated as it is a duplicate of using the SPDXRef-DOCUMENT DESCRIBES relationship",
"deprecated": true,
"description": "DEPRECATED: use relationships instead of this field. Packages, files and/or Snippets described by this SPDX document",
"items": {
"description": "SPDX ID for each Package, File, or Snippet.",
"type": "string"
},
"type": "array"
},
"documentNamespace": {
"description": "The URI provides an unambiguous mechanism for other SPDX documents to reference SPDX elements within this SPDX document.",
"type": "string"
},
"externalDocumentRefs": {
"description": "Identify any external SPDX documents referenced within this SPDX document.",
"items": {
"additionalProperties": false,
"description": "Information about an external SPDX document reference including the checksum. This allows for verification of the external references.",
"properties": {
"checksum": {
"additionalProperties": false,
"description": "A Checksum is value that allows the contents of a file to be authenticated. Even small changes to the content of the file will change its checksum. This class allows the results of a variety of checksum and cryptographic message digest algorithms to be represented.",
"properties": {
"algorithm": {
"description": "Identifies the algorithm used to produce the subject Checksum. Currently, SHA-1 is the only supported algorithm. It is anticipated that other algorithms will be supported at a later time.",
"enum": [
"SHA1",
"BLAKE3",
"SHA3-384",
"SHA256",
"SHA384",
"BLAKE2b-512",
"BLAKE2b-256",
"SHA3-512",
"MD2",
"ADLER32",
"MD4",
"SHA3-256",
"BLAKE2b-384",
"SHA512",
"MD6",
"MD5",
"SHA224"
],
"type": "string"
},
"checksumValue": {
"description": "The checksumValue property provides a lower case hexidecimal encoded digest value produced using a specific algorithm.",
"type": "string"
}
},
"required": [
"algorithm",
"checksumValue"
],
"type": "object"
},
"externalDocumentId": {
"description": "externalDocumentId is a string containing letters, numbers, ., - and/or + which uniquely identifies an external document within this document.",
"type": "string"
},
"spdxDocument": {
"description": "SPDX ID for SpdxDocument. A property containing an SPDX document.",
"type": "string"
}
},
"required": [
"checksum",
"externalDocumentId",
"spdxDocument"
],
"type": "object"
},
"type": "array"
},
"files": {
"description": "Files referenced in the SPDX document",
"items": {
"additionalProperties": false,
"properties": {
"SPDXID": {
"description": "Uniquely identify any element in an SPDX document which may be referenced by other elements.",
"type": "string"
},
"annotations": {
"description": "Provide additional information about an SpdxElement.",
"items": {
"additionalProperties": false,
"description": "An Annotation is a comment on an SpdxItem by an agent.",
"properties": {
"annotationDate": {
"description": "Identify when the comment was made. This is to be specified according to the combined date and time in the UTC format, as specified in the ISO 8601 standard.",
"type": "string"
},
"annotationType": {
"description": "Type of the annotation.",
"enum": [
"OTHER",
"REVIEW"
],
"type": "string"
},
"annotator": {
"description": "This field identifies the person, organization, or tool that has commented on a file, package, snippet, or the entire document.",
"type": "string"
},
"comment": {
"type": "string"
}
},
"required": [
"annotationDate",
"annotationType",
"annotator",
"comment"
],
"type": "object"
},
"type": "array"
},
"artifactOfs": {
"description": "Indicates the project in which the SpdxElement originated. Tools must preserve doap:homepage and doap:name properties and the URI (if one is known) of doap:Project resources that are values of this property. All other properties of doap:Projects are not directly supported by SPDX and may be dropped when translating to or from some SPDX formats.",
"items": {
"type": "object"
},
"type": "array"
},
"attributionTexts": {
"description": "This field provides a place for the SPDX data creator to record acknowledgements that may be required to be communicated in some contexts. This is not meant to include the actual complete license text (see licenseConculded and licenseDeclared), and may or may not include copyright notices (see also copyrightText). The SPDX data creator may use this field to record other acknowledgements, such as particular clauses from license texts, which may be necessary or desirable to reproduce.",
"items": {
"description": "This field provides a place for the SPDX data creator to record acknowledgements that may be required to be communicated in some contexts. This is not meant to include the actual complete license text (see licenseConculded and licenseDeclared), and may or may not include copyright notices (see also copyrightText). The SPDX data creator may use this field to record other acknowledgements, such as particular clauses from license texts, which may be necessary or desirable to reproduce.",
"type": "string"
},
"type": "array"
},
"checksums": {
"description": "The checksum property provides a mechanism that can be used to verify that the contents of a File or Package have not changed.",
"items": {
"additionalProperties": false,
"description": "A Checksum is value that allows the contents of a file to be authenticated. Even small changes to the content of the file will change its checksum. This class allows the results of a variety of checksum and cryptographic message digest algorithms to be represented.",
"properties": {
"algorithm": {
"description": "Identifies the algorithm used to produce the subject Checksum. Currently, SHA-1 is the only supported algorithm. It is anticipated that other algorithms will be supported at a later time.",
"enum": [
"SHA1",
"BLAKE3",
"SHA3-384",
"SHA256",
"SHA384",
"BLAKE2b-512",
"BLAKE2b-256",
"SHA3-512",
"MD2",
"ADLER32",
"MD4",
"SHA3-256",
"BLAKE2b-384",
"SHA512",
"MD6",
"MD5",
"SHA224"
],
"type": "string"
},
"checksumValue": {
"description": "The checksumValue property provides a lower case hexidecimal encoded digest value produced using a specific algorithm.",
"type": "string"
}
},
"required": [
"algorithm",
"checksumValue"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"comment": {
"type": "string"
},
"copyrightText": {
"description": "The text of copyright declarations recited in the package, file or snippet.\n\nIf the copyrightText field is not present, it implies an equivalent meaning to NOASSERTION.",
"type": "string"
},
"fileContributors": {
"description": "This field provides a place for the SPDX file creator to record file contributors. Contributors could include names of copyright holders and/or authors who may not be copyright holders yet contributed to the file content.",
"items": {
"description": "This field provides a place for the SPDX file creator to record file contributors. Contributors could include names of copyright holders and/or authors who may not be copyright holders yet contributed to the file content.",
"type": "string"
},
"type": "array"
},
"fileDependencies": {
"deprecated": true,
"description": "This field is deprecated since SPDX 2.0 in favor of using Section 7 which provides more granularity about relationships.",
"items": {
"description": "SPDX ID for File. This field is deprecated since SPDX 2.0 in favor of using Section 7 which provides more granularity about relationships.",
"type": "string"
},
"type": "array"
},
"fileName": {
"description": "The name of the file relative to the root of the package.",
"type": "string"
},
"fileTypes": {
"description": "The type of the file.",
"items": {
"description": "The type of the file.",
"enum": [
"OTHER",
"DOCUMENTATION",
"IMAGE",
"VIDEO",
"ARCHIVE",
"SPDX",
"APPLICATION",
"SOURCE",
"BINARY",
"TEXT",
"AUDIO"
],
"type": "string"
},
"type": "array"
},
"licenseComments": {
"description": "The licenseComments property allows the preparer of the SPDX document to describe why the licensing in spdx:licenseConcluded was chosen.",
"type": "string"
},
"licenseConcluded": {
"description": "License expression for licenseConcluded. See SPDX Annex D for the license expression syntax. The licensing that the preparer of this SPDX document has concluded, based on the evidence, actually applies to the SPDX Item.\n\nIf the licenseConcluded field is not present for an SPDX Item, it implies an equivalent meaning to NOASSERTION.",
"type": "string"
},
"licenseInfoInFiles": {
"description": "Licensing information that was discovered directly in the subject file. This is also considered a declared license for the file.\n\nIf the licenseInfoInFile field is not present for a file, it implies an equivalent meaning to NOASSERTION.",
"items": {
"description": "License expression for licenseInfoInFile. See SPDX Annex D for the license expression syntax. Licensing information that was discovered directly in the subject file. This is also considered a declared license for the file.\n\nIf the licenseInfoInFile field is not present for a file, it implies an equivalent meaning to NOASSERTION.",
"type": "string"
},
"type": "array"
},
"noticeText": {
"description": "This field provides a place for the SPDX file creator to record potential legal notices found in the file. This may or may not include copyright statements.",
"type": "string"
}
},
"required": [
"SPDXID",
"checksums",
"fileName"
],
"type": "object"
},
"type": "array"
},
"hasExtractedLicensingInfos": {
"description": "Indicates that a particular ExtractedLicensingInfo was defined in the subject SpdxDocument.",
"items": {
"additionalProperties": false,
"description": "An ExtractedLicensingInfo represents a license or licensing notice that was found in a package, file or snippet. Any license text that is recognized as a license may be represented as a License rather than an ExtractedLicensingInfo.",
"properties": {
"comment": {
"type": "string"
},
"crossRefs": {
"description": "Cross Reference Detail for a license SeeAlso URL",
"items": {
"additionalProperties": false,
"description": "Cross reference details for the a URL reference",
"properties": {
"isLive": {
"description": "Indicate a URL is still a live accessible location on the public internet",
"type": "boolean"
},
"isValid": {
"description": "True if the URL is a valid well formed URL",
"type": "boolean"
},
"isWayBackLink": {
"description": "True if the License SeeAlso URL points to a Wayback archive",
"type": "boolean"
},
"match": {
"description": "Status of a License List SeeAlso URL reference if it refers to a website that matches the license text.",
"type": "string"
},
"order": {
"description": "The ordinal order of this element within a list",
"type": "integer"
},
"timestamp": {
"description": "Timestamp",
"type": "string"
},
"url": {
"description": "URL Reference",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"type": "array"
},
"extractedText": {
"description": "Provide a copy of the actual text of the license reference extracted from the package, file or snippet that is associated with the License Identifier to aid in future analysis.",
"type": "string"
},
"licenseId": {
"description": "A human readable short form license identifier for a license. The license ID is either on the standard license list or the form \"LicenseRef-[idString]\" where [idString] is a unique string containing letters, numbers, \".\" or \"-\". When used within a license expression, the license ID can optionally include a reference to an external document in the form \"DocumentRef-[docrefIdString]:LicenseRef-[idString]\" where docRefIdString is an ID for an external document reference.",
"type": "string"
},
"name": {
"description": "Identify name of this SpdxElement.",
"type": "string"
},
"seeAlsos": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"extractedText",
"licenseId"
],
"type": "object"
},
"type": "array"
},
"name": {
"description": "Identify name of this SpdxElement.",
"type": "string"
},
"packages": {
"description": "Packages referenced in the SPDX document",
"items": {
"additionalProperties": false,
"properties": {
"SPDXID": {
"description": "Uniquely identify any element in an SPDX document which may be referenced by other elements.",
"type": "string"
},
"annotations": {
"description": "Provide additional information about an SpdxElement.",
"items": {
"additionalProperties": false,
"description": "An Annotation is a comment on an SpdxItem by an agent.",
"properties": {
"annotationDate": {
"description": "Identify when the comment was made. This is to be specified according to the combined date and time in the UTC format, as specified in the ISO 8601 standard.",
"type": "string"
},
"annotationType": {
"description": "Type of the annotation.",
"enum": [
"OTHER",
"REVIEW"
],
"type": "string"
},
"annotator": {
"description": "This field identifies the person, organization, or tool that has commented on a file, package, snippet, or the entire document.",
"type": "string"
},
"comment": {
"type": "string"
}
},
"required": [
"annotationDate",
"annotationType",
"annotator",
"comment"
],
"type": "object"
},
"type": "array"
},
"attributionTexts": {
"description": "This field provides a place for the SPDX data creator to record acknowledgements that may be required to be communicated in some contexts. This is not meant to include the actual complete license text (see licenseConculded and licenseDeclared), and may or may not include copyright notices (see also copyrightText). The SPDX data creator may use this field to record other acknowledgements, such as particular clauses from license texts, which may be necessary or desirable to reproduce.",
"items": {
"description": "This field provides a place for the SPDX data creator to record acknowledgements that may be required to be communicated in some contexts. This is not meant to include the actual complete license text (see licenseConculded and licenseDeclared), and may or may not include copyright notices (see also copyrightText). The SPDX data creator may use this field to record other acknowledgements, such as particular clauses from license texts, which may be necessary or desirable to reproduce.",
"type": "string"
},
"type": "array"
},
"builtDate": {
"description": "This field provides a place for recording the actual date the package was built.",
"type": "string"
},
"checksums": {
"description": "The checksum property provides a mechanism that can be used to verify that the contents of a File or Package have not changed.",
"items": {
"additionalProperties": false,
"description": "A Checksum is value that allows the contents of a file to be authenticated. Even small changes to the content of the file will change its checksum. This class allows the results of a variety of checksum and cryptographic message digest algorithms to be represented.",
"properties": {
"algorithm": {
"description": "Identifies the algorithm used to produce the subject Checksum. Currently, SHA-1 is the only supported algorithm. It is anticipated that other algorithms will be supported at a later time.",
"enum": [
"SHA1",
"BLAKE3",
"SHA3-384",
"SHA256",
"SHA384",
"BLAKE2b-512",
"BLAKE2b-256",
"SHA3-512",
"MD2",
"ADLER32",
"MD4",
"SHA3-256",
"BLAKE2b-384",
"SHA512",
"MD6",
"MD5",
"SHA224"
],
"type": "string"
},
"checksumValue": {
"description": "The checksumValue property provides a lower case hexidecimal encoded digest value produced using a specific algorithm.",
"type": "string"
}
},
"required": [
"algorithm",
"checksumValue"
],
"type": "object"
},
"type": "array"
},
"comment": {
"type": "string"
},
"copyrightText": {
"description": "The text of copyright declarations recited in the package, file or snippet.\n\nIf the copyrightText field is not present, it implies an equivalent meaning to NOASSERTION.",
"type": "string"
},
"description": {
"description": "Provides a detailed description of the package.",
"type": "string"
},
"downloadLocation": {
"description": "The URI at which this package is available for download. Private (i.e., not publicly reachable) URIs are acceptable as values of this property. The values http://spdx.org/rdf/terms#none and http://spdx.org/rdf/terms#noassertion may be used to specify that the package is not downloadable or that no attempt was made to determine its download location, respectively.",
"type": "string"
},
"externalRefs": {
"description": "An External Reference allows a Package to reference an external source of additional information, metadata, enumerations, asset identifiers, or downloadable content believed to be relevant to the Package.",
"items": {
"additionalProperties": false,
"description": "An External Reference allows a Package to reference an external source of additional information, metadata, enumerations, asset identifiers, or downloadable content believed to be relevant to the Package.",
"properties": {
"comment": {
"type": "string"
},
"referenceCategory": {
"description": "Category for the external reference",
"enum": [
"OTHER",
"PERSISTENT-ID",
"PERSISTENT_ID",
"SECURITY",
"PACKAGE-MANAGER",
"PACKAGE_MANAGER"
],
"type": "string"
},
"referenceLocator": {
"description": "The unique string with no spaces necessary to access the package-specific information, metadata, or content within the target location. The format of the locator is subject to constraints defined by the <type>.",
"type": "string"
},
"referenceType": {
"description": "Type of the external reference. These are defined in an appendix in the SPDX specification.",
"type": "string"
}
},
"required": [
"referenceCategory",
"referenceLocator",
"referenceType"
],
"type": "object"
},
"type": "array"
},
"filesAnalyzed": {
"description": "Indicates whether the file content of this package has been available for or subjected to analysis when creating the SPDX document. If false indicates packages that represent metadata or URI references to a project, product, artifact, distribution or a component. If set to false, the package must not contain any files.",
"type": "boolean"
},
"hasFiles": {
"$comment": "This field has been deprecated as it is a duplicate of using CONTAINS relationships from a package to files",
"deprecated": true,
"description": "DEPRECATED: use relationships instead of this field. Indicates that a particular file belongs to a package.",
"items": {
"description": "SPDX ID for File. Indicates that a particular file belongs to a package.",
"type": "string"
},
"type": "array"
},
"homepage": {
"type": "string"
},
"licenseComments": {
"description": "The licenseComments property allows the preparer of the SPDX document to describe why the licensing in spdx:licenseConcluded was chosen.",
"type": "string"
},
"licenseConcluded": {
"description": "License expression for licenseConcluded. See SPDX Annex D for the license expression syntax. The licensing that the preparer of this SPDX document has concluded, based on the evidence, actually applies to the SPDX Item.\n\nIf the licenseConcluded field is not present for an SPDX Item, it implies an equivalent meaning to NOASSERTION.",
"type": "string"
},
"licenseDeclared": {
"description": "License expression for licenseDeclared. See SPDX Annex D for the license expression syntax. The licensing that the creators of the software in the package, or the packager, have declared. Declarations by the original software creator should be preferred, if they exist.",
"type": "string"
},
"licenseInfoFromFiles": {
"description": "The licensing information that was discovered directly within the package. There will be an instance of this property for each distinct value of alllicenseInfoInFile properties of all files contained in the package.\n\nIf the licenseInfoFromFiles field is not present for a package and filesAnalyzed property for that same package is true or omitted, it implies an equivalent meaning to NOASSERTION.",
"items": {
"description": "License expression for licenseInfoFromFiles. See SPDX Annex D for the license expression syntax. The licensing information that was discovered directly within the package. There will be an instance of this property for each distinct value of alllicenseInfoInFile properties of all files contained in the package.\n\nIf the licenseInfoFromFiles field is not present for a package and filesAnalyzed property for that same package is true or omitted, it implies an equivalent meaning to NOASSERTION.",
"type": "string"
},
"type": "array"
},
"name": {
"description": "Identify name of this SpdxElement.",
"type": "string"
},
"originator": {
"description": "The name and, optionally, contact information of the person or organization that originally created the package. Values of this property must conform to the agent and tool syntax.",
"type": "string"
},
"packageFileName": {
"description": "The base name of the package file name. For example, zlib-1.2.5.tar.gz.",
"type": "string"
},
"packageVerificationCode": {
"additionalProperties": false,
"description": "A manifest based verification code (the algorithm is defined in section 4.7 of the full specification) of the SPDX Item. This allows consumers of this data and/or database to determine if an SPDX item they have in hand is identical to the SPDX item from which the data was produced. This algorithm works even if the SPDX document is included in the SPDX item.",
"properties": {
"packageVerificationCodeExcludedFiles": {
"description": "A file that was excluded when calculating the package verification code. This is usually a file containing SPDX data regarding the package. If a package contains more than one SPDX file all SPDX files must be excluded from the package verification code. If this is not done it would be impossible to correctly calculate the verification codes in both files.",
"items": {
"description": "A file that was excluded when calculating the package verification code. This is usually a file containing SPDX data regarding the package. If a package contains more than one SPDX file all SPDX files must be excluded from the package verification code. If this is not done it would be impossible to correctly calculate the verification codes in both files.",
"type": "string"
},
"type": "array"
},
"packageVerificationCodeValue": {
"description": "The actual package verification code as a hex encoded value.",
"type": "string"
}
},
"required": [
"packageVerificationCodeValue"
],
"type": "object"
},
"primaryPackagePurpose": {
"description": "This field provides information about the primary purpose of the identified package. Package Purpose is intrinsic to how the package is being used rather than the content of the package.",
"enum": [
"OTHER",
"INSTALL",
"ARCHIVE",
"FIRMWARE",
"APPLICATION",
"FRAMEWORK",
"LIBRARY",
"CONTAINER",
"SOURCE",
"DEVICE",
"OPERATING_SYSTEM",
"FILE"
],
"type": "string"
},
"releaseDate": {
"description": "This field provides a place for recording the date the package was released.",
"type": "string"
},
"sourceInfo": {
"description": "Allows the producer(s) of the SPDX document to describe how the package was acquired and/or changed from the original source.",
"type": "string"
},
"summary": {
"description": "Provides a short description of the package.",
"type": "string"
},
"supplier": {
"description": "The name and, optionally, contact information of the person or organization who was the immediate supplier of this package to the recipient. The supplier may be different than originator when the software has been repackaged. Values of this property must conform to the agent and tool syntax.",
"type": "string"
},
"validUntilDate": {
"description": "This field provides a place for recording the end of the support period for a package from the supplier.",
"type": "string"
},
"versionInfo": {
"description": "Provides an indication of the version of the package that is described by this SpdxDocument.",
"type": "string"
}
},
"required": [
"SPDXID",
"downloadLocation",
"name"
],
"type": "object"
},
"type": "array"
},
"relationships": {
"description": "Relationships referenced in the SPDX document",
"items": {
"additionalProperties": false,
"properties": {
"comment": {
"type": "string"
},
"relatedSpdxElement": {
"description": "SPDX ID for SpdxElement. A related SpdxElement.",
"type": "string"
},
"relationshipType": {
"description": "Describes the type of relationship between two SPDX elements.",
"enum": [
"VARIANT_OF",
"COPY_OF",
"PATCH_FOR",
"TEST_DEPENDENCY_OF",
"CONTAINED_BY",
"DATA_FILE_OF",
"OPTIONAL_COMPONENT_OF",
"ANCESTOR_OF",
"GENERATES",
"CONTAINS",
"OPTIONAL_DEPENDENCY_OF",
"FILE_ADDED",
"REQUIREMENT_DESCRIPTION_FOR",
"DEV_DEPENDENCY_OF",
"DEPENDENCY_OF",
"BUILD_DEPENDENCY_OF",
"DESCRIBES",
"PREREQUISITE_FOR",
"HAS_PREREQUISITE",
"PROVIDED_DEPENDENCY_OF",
"DYNAMIC_LINK",
"DESCRIBED_BY",
"METAFILE_OF",
"DEPENDENCY_MANIFEST_OF",
"PATCH_APPLIED",
"RUNTIME_DEPENDENCY_OF",
"TEST_OF",
"TEST_TOOL_OF",
"DEPENDS_ON",
"SPECIFICATION_FOR",
"FILE_MODIFIED",
"DISTRIBUTION_ARTIFACT",
"AMENDS",
"DOCUMENTATION_OF",
"GENERATED_FROM",
"STATIC_LINK",
"OTHER",
"BUILD_TOOL_OF",
"TEST_CASE_OF",
"PACKAGE_OF",
"DESCENDANT_OF",
"FILE_DELETED",
"EXPANDED_FROM_ARCHIVE",
"DEV_TOOL_OF",
"EXAMPLE_OF"
],
"type": "string"
},
"spdxElementId": {
"description": "Id to which the SPDX element is related",
"type": "string"
}
},
"required": [
"spdxElementId",
"relatedSpdxElement",
"relationshipType"
],
"type": "object"
},
"type": "array"
},
"revieweds": {
"deprecated": true,
"description": "Reviewed",
"items": {
"additionalProperties": false,
"description": "This class has been deprecated in favor of an Annotation with an Annotation type of review.",
"properties": {
"comment": {
"type": "string"
},
"reviewDate": {
"description": "The date and time at which the SpdxDocument was reviewed. This value must be in UTC and have 'Z' as its timezone indicator.",
"type": "string"
},
"reviewer": {
"description": "The name and, optionally, contact information of the person who performed the review. Values of this property must conform to the agent and tool syntax. The reviewer property is deprecated in favor of Annotation with an annotationType review.",
"type": "string"
}
},
"required": [
"reviewDate"
],
"type": "object"
},
"type": "array"
},
"snippets": {
"description": "Snippets referenced in the SPDX document",
"items": {
"additionalProperties": false,
"properties": {
"SPDXID": {
"description": "Uniquely identify any element in an SPDX document which may be referenced by other elements.",
"type": "string"
},
"annotations": {
"description": "Provide additional information about an SpdxElement.",
"items": {
"additionalProperties": false,
"description": "An Annotation is a comment on an SpdxItem by an agent.",
"properties": {
"annotationDate": {
"description": "Identify when the comment was made. This is to be specified according to the combined date and time in the UTC format, as specified in the ISO 8601 standard.",
"type": "string"
},
"annotationType": {
"description": "Type of the annotation.",
"enum": [
"OTHER",
"REVIEW"
],
"type": "string"
},
"annotator": {
"description": "This field identifies the person, organization, or tool that has commented on a file, package, snippet, or the entire document.",
"type": "string"
},
"comment": {
"type": "string"
}
},
"required": [
"annotationDate",
"annotationType",
"annotator",
"comment"
],
"type": "object"
},
"type": "array"
},
"attributionTexts": {
"description": "This field provides a place for the SPDX data creator to record acknowledgements that may be required to be communicated in some contexts. This is not meant to include the actual complete license text (see licenseConculded and licenseDeclared), and may or may not include copyright notices (see also copyrightText). The SPDX data creator may use this field to record other acknowledgements, such as particular clauses from license texts, which may be necessary or desirable to reproduce.",
"items": {
"description": "This field provides a place for the SPDX data creator to record acknowledgements that may be required to be communicated in some contexts. This is not meant to include the actual complete license text (see licenseConculded and licenseDeclared), and may or may not include copyright notices (see also copyrightText). The SPDX data creator may use this field to record other acknowledgements, such as particular clauses from license texts, which may be necessary or desirable to reproduce.",
"type": "string"
},
"type": "array"
},
"comment": {
"type": "string"
},
"copyrightText": {
"description": "The text of copyright declarations recited in the package, file or snippet.\n\nIf the copyrightText field is not present, it implies an equivalent meaning to NOASSERTION.",
"type": "string"
},
"licenseComments": {
"description": "The licenseComments property allows the preparer of the SPDX document to describe why the licensing in spdx:licenseConcluded was chosen.",
"type": "string"
},
"licenseConcluded": {
"description": "License expression for licenseConcluded. See SPDX Annex D for the license expression syntax. The licensing that the preparer of this SPDX document has concluded, based on the evidence, actually applies to the SPDX Item.\n\nIf the licenseConcluded field is not present for an SPDX Item, it implies an equivalent meaning to NOASSERTION.",
"type": "string"
},
"licenseInfoInSnippets": {
"description": "Licensing information that was discovered directly in the subject snippet. This is also considered a declared license for the snippet.\n\nIf the licenseInfoInSnippet field is not present for a snippet, it implies an equivalent meaning to NOASSERTION.",
"items": {
"description": "License expression for licenseInfoInSnippet. See SPDX Annex D for the license expression syntax. Licensing information that was discovered directly in the subject snippet. This is also considered a declared license for the snippet.\n\nIf the licenseInfoInSnippet field is not present for a snippet, it implies an equivalent meaning to NOASSERTION.",
"type": "string"
},
"type": "array"
},
"name": {
"description": "Identify name of this SpdxElement.",
"type": "string"
},
"ranges": {
"description": "This field defines the byte range in the original host file (in X.2) that the snippet information applies to",
"items": {
"additionalProperties": false,
"properties": {
"endPointer": {
"additionalProperties": false,
"properties": {
"lineNumber": {
"description": "line number offset in the file",
"type": "integer"
},
"offset": {
"description": "Byte offset in the file",
"type": "integer"
},
"reference": {
"description": "SPDX ID for File",
"type": "string"
}
},
"required": [
"reference"
],
"type": "object"
},
"startPointer": {
"additionalProperties": false,
"properties": {
"lineNumber": {
"description": "line number offset in the file",
"type": "integer"
},
"offset": {
"description": "Byte offset in the file",
"type": "integer"
},
"reference": {
"description": "SPDX ID for File",
"type": "string"
}
},
"required": [
"reference"
],
"type": "object"
}
},
"required": [
"endPointer",
"startPointer"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"snippetFromFile": {
"description": "SPDX ID for File. File containing the SPDX element (e.g. the file contaning a snippet).",
"type": "string"
}
},
"required": [
"SPDXID",
"name",
"ranges",
"snippetFromFile"
],
"type": "object"
},
"type": "array"
},
"spdxVersion": {
"description": "Provide a reference number that can be used to understand how to parse and interpret the rest of the file. It will enable both future changes to the specification and to support backward compatibility. The version number consists of a major and minor version indicator. The major field will be incremented when incompatible changes between versions are made (one or more sections are created, modified or deleted). The minor field will be incremented when backwards compatible changes are made.",
"type": "string"
}
},
"required": [
"SPDXID",
"creationInfo",
"dataLicense",
"name",
"spdxVersion",
"documentNamespace"
],
"title": "SPDX 2.3",
"type": "object"
} | MIT | en |
mykola927/myApplication-main | 4a3a2536e394c3cec78725782f54d54e6768746c | 2022-07-19T21:55:07 | terraform/helm/vector-daemonset/values.schema.json | 5 | 2024-05-27T06:28:04.880399Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"env": {
"additionalProperties": {
"type": "array"
},
"type": "object"
},
"k8s_cluster": {
"description": "A human readable name for the k8s cluster. This will be added as field 'k8s_cluster' to each log event.",
"type": "string"
},
"logging_sinks": {
"additionalProperties": {
"type": "object"
},
"minProperties": 1,
"type": "object"
}
},
"required": [
"k8s_cluster",
"logging_sinks",
"env"
]
} | Apache-2.0 | en |
GitOpsLovers/nx-biome | f9b1036369fe71e97f9d4f6e9bf10542086e2416 | 2024-03-06T16:49:57 | plugin/src/generators/configuration/schema.json | 10 | 2024-05-27T06:41:15.005228Z | {
"$id": "NxBiomeProjectConfiguration",
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": false,
"properties": {
"linter": {
"default": true,
"description": "Add linting with Biome to the project.",
"type": "boolean"
},
"project": {
"$default": {
"$source": "projectName"
},
"description": "The name of the project.",
"type": "string",
"x-priority": "important"
}
},
"required": [
"project"
],
"title": "Add Biome configuration to a project.",
"type": "object"
} | MIT | en |
GitOpsLovers/nx-biome | 73d3f829ca1f197647a600eae259c099fd3b4a37 | 2024-04-11T11:11:05 | plugin/src/generators/configuration/schema.json | 10 | 2024-05-27T06:41:15.005228Z | {
"$id": "NxBiomeProjectConfiguration",
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": false,
"properties": {
"linter": {
"default": true,
"description": "Add linting with Biome to the project.",
"type": "boolean",
"x-prompt": {
"message": "Include the Linter functionality in the configuration?",
"type": "boolean"
}
},
"project": {
"description": "The name of the project.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "Which project do you want to add the configuration?"
}
},
"required": [
"project"
],
"title": "Add Biome configuration to a project.",
"type": "object"
} | MIT | en |
lucapisano/GreenPassValidator | 540f28fe0a7de2cee92c0c741a0f50d72603aa65 | 2021-09-02T21:06:35 | GreenPass/Services/DGC/V1/EU_DGC.json | 24 | 2024-05-28T05:39:33.962971Z | {
"$defs": {
"certificate_id": {
"description": "Certificate Identifier, UVCI",
"maxLength": 50,
"type": "string"
},
"country_vt": {
"description": "Country of Vaccination / Test, ISO 3166 where possible",
"pattern": "[A-Z]{1,10}",
"type": "string"
},
"disease-agent-targeted": {
"description": "EU eHealthNetwork: Value Sets for Digital Green Certificates. version 1.0, 2021-04-16, section 2.1",
"type": "string"
},
"dose_posint": {
"description": "Dose Number / Total doses in Series: positive integer, range: [1,9]",
"maximum": 9,
"minimum": 1,
"type": "integer"
},
"issuer": {
"description": "Certificate Issuer",
"maxLength": 50,
"type": "string"
},
"person_name": {
"description": "Person name: Surname(s), given name(s) - in that order",
"properties": {
"fn": {
"description": "The family or primary name(s) of the person addressed in the certificate",
"examples": [
"d'\u010cervenkov\u00e1 Panklov\u00e1"
],
"maxLength": 50,
"title": "Family name",
"type": "string"
},
"fnt": {
"description": "The family name(s) of the person transliterated",
"examples": [
"DCERVENKOVA<PANKLOVA"
],
"maxLength": 50,
"pattern": "^[A-Z<]*$",
"title": "Standardised family name",
"type": "string"
},
"gn": {
"description": "The given name(s) of the person addressed in the certificate",
"examples": [
"Ji\u0159ina-Maria Alena"
],
"maxLength": 50,
"title": "Given name",
"type": "string"
},
"gnt": {
"$comment": "SematicSG: ICAO transliterated has max length of?",
"description": "The given name(s) of the person transliterated",
"examples": [
"JIRINA<MARIA<ALENA"
],
"maxLength": 50,
"pattern": "^[A-Z<]*$",
"title": "Standardised given name",
"type": "string"
}
},
"required": [
"fnt"
],
"type": "object"
},
"recovery_entry": {
"description": "Recovery Entry",
"properties": {
"ci": {
"$ref": "#/$defs/certificate_id",
"description": "Unique Certificate Identifier, UVCI"
},
"co": {
"$ref": "#/$defs/country_vt",
"description": "Country of Test"
},
"df": {
"description": "ISO 8601 Date: Certificate Valid From",
"format": "date",
"type": "string"
},
"du": {
"description": "Certificate Valid Until",
"format": "date",
"type": "string"
},
"fr": {
"description": "ISO 8601 Date of First Positive Test Result",
"format": "date",
"type": "string"
},
"is": {
"$ref": "#/$defs/issuer",
"description": "Certificate Issuer"
},
"tg": {
"$ref": "#/$defs/disease-agent-targeted"
}
},
"required": [
"tg",
"fr",
"co",
"is",
"df",
"du",
"ci"
],
"type": "object"
},
"test-manf": {
"description": "EU eHealthNetwork: Value Sets for Digital Green Certificates. version 1.0, 2021-04-16, section 2.8",
"type": "string"
},
"test-result": {
"description": "EU eHealthNetwork: Value Sets for Digital Green Certificates. version 1.0, 2021-04-16, section 2.9",
"type": "string"
},
"test_entry": {
"description": "Test Entry",
"properties": {
"ci": {
"$ref": "#/$defs/certificate_id",
"description": "Unique Certificate Identifier, UVCI"
},
"co": {
"$ref": "#/$defs/country_vt",
"description": "Country of Test"
},
"dr": {
"description": "Date/Time of Test Result",
"format": "date-time",
"type": "string"
},
"is": {
"$ref": "#/$defs/issuer",
"description": "Certificate Issuer"
},
"ma": {
"$ref": "#/$defs/test-manf",
"description": "RAT Test name and manufacturer"
},
"nm": {
"description": "NAA Test Name",
"type": "string"
},
"sc": {
"description": "Date/Time of Sample Collection",
"format": "date-time",
"type": "string"
},
"tc": {
"description": "Testing Centre",
"maxLength": 50,
"type": "string"
},
"tg": {
"$ref": "#/$defs/disease-agent-targeted"
},
"tr": {
"$ref": "#/$defs/test-result",
"description": "Test Result"
},
"tt": {
"description": "Type of Test",
"type": "string"
}
},
"required": [
"tg",
"tt",
"sc",
"tr",
"tc",
"co",
"is",
"ci"
],
"type": "object"
},
"vaccination_entry": {
"description": "Vaccination Entry",
"properties": {
"ci": {
"$ref": "#/$defs/certificate_id",
"description": "Unique Certificate Identifier: UVCI"
},
"co": {
"$ref": "#/$defs/country_vt",
"description": "Country of Vaccination"
},
"dn": {
"$ref": "#/$defs/dose_posint",
"description": "Dose Number"
},
"dt": {
"$comment": "SemanticSG: constrain to specific date range?",
"description": "Date of Vaccination",
"format": "date",
"type": "string"
},
"is": {
"$ref": "#/$defs/issuer",
"description": "Certificate Issuer"
},
"ma": {
"$ref": "#/$defs/vaccine-mah-manf",
"description": "Marketing Authorization Holder - if no MAH present, then manufacturer"
},
"mp": {
"$ref": "#/$defs/vaccine-medicinal-product",
"description": "vaccine medicinal product"
},
"sd": {
"$ref": "#/$defs/dose_posint",
"description": "Total Series of Doses"
},
"tg": {
"$ref": "#/$defs/disease-agent-targeted",
"description": "disease or agent targeted"
},
"vp": {
"$ref": "#/$defs/vaccine-prophylaxis",
"description": "vaccine or prophylaxis"
}
},
"required": [
"tg",
"vp",
"mp",
"ma",
"dn",
"sd",
"dt",
"co",
"is",
"ci"
],
"type": "object"
},
"vaccine-mah-manf": {
"description": "EU eHealthNetwork: Value Sets for Digital Green Certificates. version 1.0, 2021-04-16, section 2.4",
"type": "string"
},
"vaccine-medicinal-product": {
"description": "EU eHealthNetwork: Value Sets for Digital Green Certificates. version 1.0, 2021-04-16, section 2.3",
"type": "string"
},
"vaccine-prophylaxis": {
"description": "EU eHealthNetwork: Value Sets for Digital Green Certificates. version 1.0, 2021-04-16, section 2.2",
"type": "string"
}
},
"$id": "https://ec.europa.eu/dgc/DGC.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "EU Digital Green Certificate",
"properties": {
"dob": {
"description": "Date of Birth of the person addressed in the DGC. ISO 8601 date format restricted to range 1900-2099",
"examples": [
"1979-04-14"
],
"format": "date",
"pattern": "[19|20][0-9][0-9]-(0[1-9]|1[0-2])-([0-2][1-9]|3[0|1])",
"title": "Date of birth",
"type": "string"
},
"nam": {
"$ref": "#/$defs/person_name",
"description": "Surname(s), given name(s) - in that order"
},
"r": {
"description": "Recovery Group",
"items": {
"$ref": "#/$defs/recovery_entry"
},
"minItems": 1,
"type": "array"
},
"t": {
"description": "Test Group",
"items": {
"$ref": "#/$defs/test_entry"
},
"minItems": 1,
"type": "array"
},
"v": {
"description": "Vaccination Group",
"items": {
"$ref": "#/$defs/vaccination_entry"
},
"minItems": 1,
"type": "array"
},
"ver": {
"description": "Version of the schema, according to Semantic versioning (ISO, https://semver.org/ version 2.0.0 or newer)",
"examples": [
"1.0.0"
],
"pattern": "^\\d+.\\d+.\\d+$",
"title": "Schema version",
"type": "string"
}
},
"required": [
"ver",
"nam",
"dob"
],
"title": "EU DGC",
"type": "object"
} | MIT | en |
opendatadiscovery/opendatadiscovery-specification | 66119cc11da3cbc9b3cd22572815d0bd2a4373e7 | 2021-04-11T17:35:40 | specification/extensions/redshift.json | 118 | 2024-05-28T00:03:43.98494Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"definitions": {
"RedshiftDataSetExtension": {
"properties": {
"diststyle": {
"type": "string"
},
"empty": {
"type": "integer"
},
"encoded": {
"enum": [
"Y",
"N"
],
"type": "string"
},
"estimated_visible_rows": {
"type": "number"
},
"max_varchar": {
"minimum": 0,
"type": "integer"
},
"pct_used": {
"type": "number"
},
"risk_event": {
"type": "string"
},
"size": {
"type": "integer"
},
"skew_rows": {
"type": "number"
},
"skew_sortkey1": {
"type": "number"
},
"sortkey1": {
"type": "string"
},
"sortkey1_enc": {
"type": "string"
},
"sortkey_num": {
"minimum": 0,
"type": "integer"
},
"stats_off": {
"type": "number"
},
"table_id": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"tbl_rows": {
"type": "number"
},
"unsorted": {
"type": "number"
},
"vacuum_sort_benefit": {
"type": "number"
}
},
"type": "object"
},
"RedshiftDataSetFieldExtension": {
"properties": {
"column_acl": {
"type": "string"
},
"data_type": {
"type": "string"
},
"distkey": {
"type": "boolean"
},
"encoding": {
"type": "string"
},
"ordinal_position": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"sortkey": {
"type": "integer"
}
},
"type": "object"
}
}
} | Apache-2.0 | en |
opendatadiscovery/opendatadiscovery-specification | 6b508ffda0e44b4261b7e1b1c580c392d0f281ac | 2021-03-09T11:34:15 | specification/extensions/glue.json | 118 | 2024-05-28T00:03:43.98494Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"definitions": {
"GlueDataSetExtension": {
"properties": {
"catalog_id": {
"type": "string"
},
"create_time": {
"format": "date-time",
"type": "string"
},
"created_by": {
"type": "string"
},
"database_name": {
"type": "string"
},
"is_registered_with_lake_formation": {
"type": "boolean"
},
"last_access_time": {
"format": "date-time",
"type": "string"
},
"parameters": {
"items": {
"type": "string"
},
"type": "array"
},
"partition_keys": {
"items": {
"type": "string"
},
"type": "array"
},
"retention": {
"type": "string"
},
"storage_descriptor": {
"$ref": "#/definitions/GlueStorageDescriptor"
},
"table_type": {
"type": "string"
}
},
"type": "object"
},
"GlueDataTransformerExtension": {
"properties": {
"created_on": {
"format": "date-time",
"type": "string"
},
"glue_version": {
"type": "string"
},
"last_modified_on": {
"format": "date-time",
"type": "string"
},
"max_capacity": {
"type": "number"
},
"max_retries": {
"type": "integer"
},
"number_of_workers": {
"type": "integer"
},
"role": {
"type": "string"
},
"worker_type": {
"type": "string"
}
},
"type": "object"
},
"GlueDataTransformerRunExtension": {
"properties": {
"attempt": {
"type": "integer"
},
"execution_time": {
"type": "integer"
},
"glue_version": {
"type": "string"
},
"last_modified_on": {
"format": "date-time",
"type": "string"
},
"log_group_name": {
"type": "string"
},
"max_capacity": {
"type": "number"
},
"number_of_workers": {
"type": "integer"
},
"previous_run_id": {
"type": "string"
},
"timeout": {
"type": "integer"
},
"trigger_name": {
"type": "string"
},
"worker_type": {
"type": "string"
}
},
"type": "object"
},
"GlueStorageDescriptor": {
"properties": {
"bucket_columns": {
"items": {
"type": "string"
},
"type": "array"
},
"compressed": {
"type": "string"
},
"input_format": {
"type": "string"
},
"location": {
"type": "string"
},
"number_of_buckets": {
"type": "integer"
},
"output_format": {
"type": "string"
},
"sort_columns": {
"items": {
"type": "string"
},
"type": "array"
},
"stored_as_sub_directories": {
"type": "boolean"
}
},
"type": "object"
}
}
} | Apache-2.0 | en |
opendatadiscovery/opendatadiscovery-specification | 4e1324e81200df893ef01aa9fd6cd5df076c409b | 2021-04-09T18:29:34 | specification/extensions/dynamodb.json | 118 | 2024-05-28T00:03:43.98494Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"definitions": {
"DynamoDBDataSetExtension": {
"properties": {
"archival_summary": {
"archival_backup_arn": {
"type": "string"
},
"archival_date_time": {
"format": "date-time",
"type": "string"
},
"archival_reason": {
"type": "string"
}
},
"global_secondary_indexes": {
"items": {
"$ref": "#/definitions/DynamoDBGlobalSecondaryIndexInfo"
},
"type": "array"
},
"global_table_version": {
"type": "string"
},
"key_schema": {
"items": {
"$ref": "#/definitions/DynamoDBKeySchema"
},
"type": "array"
},
"latest_stream_arn": {
"type": "string"
},
"latest_stream_label": {
"type": "string"
},
"local_secondary_indexes": {
"items": {
"$ref": "#/definitions/DynamoDBLocalSecondaryIndexInfo"
},
"type": "array"
},
"provisioned_throughput": {
"$ref": "#/definitions/DynamoDBProvisionedThroughput"
},
"replicas": {
"items": {
"properties": {
"global_secondary_indexes": {
"items": {
"properties": {
"index_name": {
"type": "string"
},
"provisioned_throughput_override": {
"$ref": "#/definitions/DynamoDBProvisionedThroughputOverride"
}
},
"type": "object"
},
"type": "array"
},
"kms_master_key_id": {
"type": "string"
},
"provisioned_throughput_override": {
"$ref": "#/definitions/DynamoDBProvisionedThroughputOverride"
},
"region_name": {
"type": "string"
},
"replica_inaccessible_date_time": {
"format": "date-time",
"type": "string"
},
"replica_status": {
"enum": [
"CREATING",
"CREATION_FAILED",
"UPDATING",
"DELETING",
"ACTIVE",
"REGION_DISABLED",
"INACCESSIBLE_ENCRYPTION_CREDENTIALS"
],
"type": "string"
},
"replica_status_description": {
"type": "string"
},
"replica_status_percent_progress": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"restore_summary": {
"restore_date_time": {
"format": "date-time",
"type": "string"
},
"restore_in_progress": {
"type": "boolean"
},
"source_backup_arn": {
"type": "string"
},
"source_table_arn": {
"type": "string"
}
},
"sse_description": {
"inaccessible_encryption_date_time": {
"format": "date-time",
"type": "string"
},
"kms_master_key_arn": {
"type": "string"
},
"sse_type": {
"enum": [
"AES256",
"KMS"
],
"type": "string"
},
"status": {
"enum": [
"ENABLING",
"ENABLED",
"DISABLING",
"DISABLED",
"UPDATING"
],
"type": "string"
}
},
"stream_specification": {
"properties": {
"stream_enabled": {
"type": "boolean"
},
"stream_view_type": {
"enum": [
"NEW_IMAGE",
"OLD_IMAGE",
"NEW_AND_OLD_IMAGES",
"KEYS_ONLY"
],
"type": "string"
}
},
"type": "object"
},
"table_arn": {
"type": "string"
},
"table_id": {
"type": "string"
},
"table_size_bytes": {
"type": "number"
},
"table_status": {
"enum": [
"CREATING",
"UPDATING",
"DELETING",
"ACTIVE",
"INACCESSIBLE_ENCRYPTION_CREDENTIALS",
"ARCHIVING",
"ARCHIVED"
],
"type": "string"
}
},
"type": "object"
},
"DynamoDBGlobalSecondaryIndexInfo": {
"allOf": [
{
"$ref": "#/definitions/DynamoDBIndexInfo"
},
{
"properties": {
"backfilling": {
"type": "boolean"
},
"index_status": {
"enum": [
"CREATING",
"UPDATING",
"DELETING",
"ACTIVE"
],
"type": "string"
},
"provisioned_throughput": {
"$ref": "#/definitions/DynamoDBProvisionedThroughput"
}
}
}
]
},
"DynamoDBIndexInfo": {
"index_arn": {
"type": "string"
},
"index_name": {
"type": "string"
},
"index_size_bytes": {
"type": "number"
},
"item_count": {
"type": "number"
},
"key_schema": {
"$ref": "#/definitions/DynamoDBKeySchema"
},
"projection": {
"non_key_attributes": {
"items": {
"type": "string"
},
"type": "array"
},
"projection_type": {
"enum": [
"ALL",
"KEYS_ONLY",
"INCLUDE"
],
"type": "string"
}
}
},
"DynamoDBKeySchema": {
"attribute_name": {
"type": "string"
},
"key_type": {
"enum": [
"HASH",
"RANGE"
],
"type": "string"
}
},
"DynamoDBLocalSecondaryIndexInfo": {
"allOf": [
{
"$ref": "#/definitions/DynamoDBIndexInfo"
}
]
},
"DynamoDBProvisionedThroughput": {
"last_decrease_date_time": {
"format": "date-time",
"type": "string"
},
"last_increase_date_time": {
"format": "date-time",
"type": "string"
},
"number_of_decreases_today": {
"type": "number"
},
"read_capacity_units": {
"type": "number"
},
"write_capacity_units": {
"type": "number"
}
},
"DynamoDBProvisionedThroughputOverride": {
"properties": {
"read_capacity_units": {
"type": "number"
}
},
"type": "object"
}
}
} | Apache-2.0 | en |
opendatadiscovery/opendatadiscovery-specification | e3be8a66660b0a1d4666696aa4fa6c6e42c5a355 | 2021-03-18T13:48:47 | specification/extensions/glue.json | 118 | 2024-05-28T00:03:43.98494Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"definitions": {
"GlueDataSetExtension": {
"properties": {
"catalog_id": {
"type": "string"
},
"created_by": {
"type": "string"
},
"database_name": {
"type": "string"
},
"is_registered_with_lake_formation": {
"type": "boolean"
},
"last_access_time": {
"format": "date-time",
"type": "string"
},
"parameters": {
"items": {
"type": "string"
},
"type": "array"
},
"partition_keys": {
"items": {
"type": "string"
},
"type": "array"
},
"retention": {
"type": "string"
},
"storage_descriptor": {
"$ref": "#/definitions/GlueStorageDescriptor"
},
"table_type": {
"type": "string"
}
},
"type": "object"
},
"GlueDataTransformerExtension": {
"properties": {
"glue_version": {
"type": "string"
},
"last_modified_on": {
"format": "date-time",
"type": "string"
},
"max_capacity": {
"type": "number"
},
"max_retries": {
"type": "integer"
},
"number_of_workers": {
"type": "integer"
},
"role": {
"type": "string"
},
"worker_type": {
"type": "string"
}
},
"type": "object"
},
"GlueDataTransformerRunExtension": {
"properties": {
"attempt": {
"type": "integer"
},
"execution_time": {
"type": "integer"
},
"glue_version": {
"type": "string"
},
"last_modified_on": {
"format": "date-time",
"type": "string"
},
"log_group_name": {
"type": "string"
},
"max_capacity": {
"type": "number"
},
"number_of_workers": {
"type": "integer"
},
"previous_run_id": {
"type": "string"
},
"timeout": {
"type": "integer"
},
"trigger_name": {
"type": "string"
},
"worker_type": {
"type": "string"
}
},
"type": "object"
},
"GlueStorageDescriptor": {
"properties": {
"bucket_columns": {
"items": {
"type": "string"
},
"type": "array"
},
"compressed": {
"type": "string"
},
"input_format": {
"type": "string"
},
"location": {
"type": "string"
},
"number_of_buckets": {
"type": "integer"
},
"output_format": {
"type": "string"
},
"sort_columns": {
"items": {
"type": "string"
},
"type": "array"
},
"stored_as_sub_directories": {
"type": "boolean"
}
},
"type": "object"
}
}
} | Apache-2.0 | en |
opendatadiscovery/opendatadiscovery-specification | a055460914c90cc9194f6fa80d0b734f6a2f7921 | 2021-04-13T19:48:16 | specification/extensions/mysql.json | 118 | 2024-05-28T00:03:43.98494Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"definitions": {
"MysqlDataSetExtension": {
"properties": {
"auto_increment": {
"type": "integer"
},
"avg_row_length": {
"type": "integer"
},
"check_time": {
"format": "date-time",
"type": "string"
},
"checksum": {
"type": "integer"
},
"create_options": {
"type": "string"
},
"data_free": {
"type": "integer"
},
"data_length": {
"type": "integer"
},
"engine": {
"type": "string"
},
"index_length": {
"type": "integer"
},
"max_data_length": {
"type": "integer"
},
"row_format": {
"type": "string"
},
"table_collation": {
"type": "string"
},
"version": {
"type": "integer"
}
},
"type": "object"
},
"MysqlDataSetFieldExtension": {
"properties": {
"character_maximum_length": {
"type": "integer"
},
"character_octet_length": {
"type": "integer"
},
"character_set_name": {
"type": "string"
},
"collation_name": {
"type": "string"
},
"column_key": {
"type": "string"
},
"datetime_precision": {
"type": "integer"
},
"extra": {
"type": "string"
},
"generation_expression": {
"type": "string"
},
"numeric_precision": {
"type": "integer"
},
"numeric_scale": {
"type": "integer"
},
"ordinal_position": {
"type": "integer"
},
"privileges": {
"type": "string"
}
},
"type": "object"
}
}
} | Apache-2.0 | en |
opendatadiscovery/opendatadiscovery-specification | 5a82ee7c10fcb9e77fa14ad7b9799e352d81b9d3 | 2021-03-02T19:05:56 | specification/extensions/glue.json | 118 | 2024-05-28T00:03:43.98494Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"definitions": {
"GlueDataSetExtension": {
"properties": {
"catalog_id": {
"type": "string"
},
"create_time": {
"format": "date-time",
"type": "string"
},
"created_by": {
"type": "string"
},
"database_name": {
"type": "string"
},
"is_registered_with_lake_formation": {
"type": "boolean"
},
"last_access_time": {
"format": "date-time",
"type": "string"
},
"parameters": {
"items": {
"type": "string"
},
"type": "array"
},
"partition_keys": {
"items": {
"type": "string"
},
"type": "array"
},
"retention": {
"type": "string"
},
"storage_descriptor": {
"$ref": "#/definitions/GlueStorageDescriptor"
},
"table_type": {
"type": "string"
}
}
},
"GlueStorageDescriptor": {
"properties": {
"bucket_columns": {
"items": {
"type": "string"
},
"type": "array"
},
"compressed": {
"type": "string"
},
"input_format": {
"type": "string"
},
"location": {
"type": "string"
},
"number_of_buckets": {
"type": "integer"
},
"output_format": {
"type": "string"
},
"sort_columns": {
"items": {
"type": "string"
},
"type": "array"
},
"stored_as_sub_directories": {
"type": "boolean"
}
},
"type": "object"
}
}
} | Apache-2.0 | en |
opendatadiscovery/opendatadiscovery-specification | 001a07f0b347228be29b6f72b61112721a9fb6d0 | 2021-04-12T10:03:11 | specification/extensions/redshift.json | 118 | 2024-05-28T00:03:43.98494Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"definitions": {
"RedshiftDataSetExtension": {
"properties": {
"diststyle": {
"type": "string"
},
"empty": {
"type": "integer"
},
"encoded": {
"enum": [
"Y",
"N"
],
"type": "string"
},
"estimated_visible_rows": {
"type": "number"
},
"max_varchar": {
"minimum": 0,
"type": "integer"
},
"pct_used": {
"type": "number"
},
"risk_event": {
"type": "string"
},
"size": {
"type": "integer"
},
"skew_rows": {
"type": "number"
},
"skew_sortkey1": {
"type": "number"
},
"sortkey1": {
"type": "string"
},
"sortkey1_enc": {
"type": "string"
},
"sortkey_num": {
"minimum": 0,
"type": "integer"
},
"stats_off": {
"type": "number"
},
"table_id": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"tbl_rows": {
"type": "number"
},
"unsorted": {
"type": "number"
},
"vacuum_sort_benefit": {
"type": "number"
}
},
"type": "object"
},
"RedshiftDataSetFieldExtension": {
"properties": {
"column_acl": {
"type": "string"
},
"distkey": {
"type": "boolean"
},
"encoding": {
"type": "string"
},
"ordinal_position": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"sortkey": {
"type": "integer"
}
},
"type": "object"
}
}
} | Apache-2.0 | en |
opendatadiscovery/opendatadiscovery-specification | c9f11dbddddbf6d3514cdaa7eaf5510d384ac928 | 2021-08-19T08:14:50 | specification/extensions/sagemaker_featurestore.json | 118 | 2024-05-28T00:03:43.98494Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"definitions": {
"SagemakerFeaturestoreExtension": {
"properties": {
"event_time_feature_name": {
"type": "string"
},
"feature_group_arn": {
"type": "string"
},
"feature_group_status": {
"type": "string"
},
"offline_store_config": {
"properties": {
"data_catalog_config": {
"properties": {
"catalog": {
"type": "string"
},
"database": {
"type": "string"
},
"table_name": {
"type": "string"
}
},
"type": "object"
},
"disable_glue_table_creation": {
"type": "boolean"
},
"s3_storage_config": {
"properties": {
"resolved_output_s3_uri": {
"type": "string"
},
"s3_uri": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"online_store_config": {
"properties": {
"enable_online_store": {
"type": "boolean"
}
},
"type": "object"
},
"record_identifier_feature_name": {
"type": "string"
},
"response_metadata": {
"properties": {
"http_headers": {
"properties": {
"content-length": {
"type": "string"
},
"content-type": {
"type": "string"
},
"date": {
"type": "string"
},
"x-amzn-requestid": {
"type": "string"
}
},
"type": "object"
},
"http_status_code": {
"type": "integer"
},
"request_id": {
"type": "string"
},
"retry_attempts": {
"type": "integer"
}
},
"type": "object"
},
"role_arn": {
"type": "string"
}
},
"type": "object"
}
}
} | Apache-2.0 | en |
opendatadiscovery/opendatadiscovery-specification | 9812fe487f2c4ebc94810ff5dec9b7f6c3f9b04c | 2021-04-06T19:19:32 | specification/extensions/redshift.json | 118 | 2024-05-28T00:03:43.98494Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"definitions": {
"RedshiftDataSetExtensionInfo": {
"properties": {
"database": {
"type": "string"
},
"diststyle": {
"type": "string"
},
"empty": {
"type": "integer"
},
"encoded": {
"enum": [
"Y",
"N"
],
"type": "string"
},
"estimated_visible_rows": {
"type": "number"
},
"max_varchar": {
"minimum": 0,
"type": "integer"
},
"pct_used": {
"type": "number"
},
"risk_event": {
"type": "string"
},
"schema": {
"type": "string"
},
"size": {
"type": "integer"
},
"skew_rows": {
"type": "number"
},
"skew_sortkey1": {
"type": "number"
},
"sortkey1": {
"type": "string"
},
"sortkey1_enc": {
"type": "string"
},
"sortkey_num": {
"minimum": 0,
"type": "integer"
},
"stats_off": {
"type": "number"
},
"table": {
"type": "string"
},
"table_id": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"tbl_rows": {
"type": "number"
},
"unsorted": {
"type": "number"
},
"vacuum_sort_benefit": {
"type": "number"
}
},
"type": "object"
},
"RedshiftDataSetFieldExtensionRedshift": {
"properties": {
"column_acl": {
"type": "string"
},
"column_default": {
"type": "string"
},
"column_name": {
"type": "string"
},
"data_type": {
"type": "string"
},
"database_name": {
"type": "string"
},
"distkey": {
"type": "boolean"
},
"encoding": {
"type": "string"
},
"is_nullable": {
"enum": [
"YES",
"NO"
],
"type": "string"
},
"ordinal_position": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"remarks": {
"type": "string"
},
"schema_name": {
"type": "string"
},
"sortkey": {
"type": "integer"
},
"table_name": {
"type": "string"
}
},
"type": "object"
}
}
} | Apache-2.0 | en |
opendatadiscovery/opendatadiscovery-specification | 5ef1068f46e005d8e66cc41b127ddf72890a77ed | 2021-04-15T22:14:08 | specification/extensions/postgresql.json | 118 | 2024-05-28T00:03:43.98494Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"definitions": {
"PostgresqlDataSetExtension": {
"properties": {
"commit_action": {
"type": "string"
},
"is_insertable_into": {
"enum": [
"YES",
"NO"
],
"type": "string"
},
"is_typed": {
"enum": [
"YES",
"NO"
],
"type": "string"
},
"reference_generation": {
"type": "string"
},
"self_referencing_column_name": {
"type": "string"
},
"user_defined_type_catalog": {
"type": "string"
},
"user_defined_type_name": {
"type": "string"
},
"user_defined_type_schema": {
"type": "string"
},
"view_check_option": {
"enum": [
"CASCADED",
"LOCAL",
"NONE"
],
"type": "string"
},
"view_is_insertable_into": {
"enum": [
"YES",
"NO"
],
"type": "string"
},
"view_is_trigger_deletable": {
"enum": [
"YES",
"NO"
],
"type": "string"
},
"view_is_trigger_insertable_into": {
"enum": [
"YES",
"NO"
],
"type": "string"
},
"view_is_trigger_updatable": {
"enum": [
"YES",
"NO"
],
"type": "string"
},
"view_is_updatable": {
"enum": [
"YES",
"NO"
],
"type": "string"
}
},
"type": "object"
},
"PostgresqlDataSetFieldExtension": {
"properties": {
"character_maximum_length": {
"type": "integer"
},
"character_octet_length": {
"type": "integer"
},
"character_set_catalog": {
"type": "string"
},
"character_set_name": {
"type": "string"
},
"character_set_schema": {
"type": "string"
},
"collation_catalog": {
"type": "string"
},
"collation_name": {
"type": "string"
},
"collation_schema": {
"type": "string"
},
"datetime_precision": {
"type": "integer"
},
"domain_catalog": {
"type": "string"
},
"domain_name": {
"type": "string"
},
"domain_schema": {
"type": "string"
},
"dtd_identifier": {
"type": "string"
},
"generation_expression": {
"type": "string"
},
"identity_cycle": {
"enum": [
"YES",
"NO"
],
"type": "string"
},
"identity_generation": {
"enum": [
"ALWAYS",
"BY DEFAULT"
],
"type": "string"
},
"identity_increment": {
"type": "string"
},
"identity_maximum": {
"type": "string"
},
"identity_minimum": {
"type": "string"
},
"identity_start": {
"type": "string"
},
"interval_precision": {
"type": "integer"
},
"interval_type": {
"type": "string"
},
"is_generated": {
"enum": [
"ALWAYS",
"NEVER"
],
"type": "string"
},
"is_identity": {
"enum": [
"YES",
"NO"
],
"type": "string"
},
"is_self_referencing": {
"enum": [
"YES",
"NO"
],
"type": "string"
},
"is_updatable": {
"enum": [
"YES",
"NO"
],
"type": "string"
},
"maximum_cardinality": {
"type": "integer"
},
"numeric_precision": {
"type": "integer"
},
"numeric_precision_radix": {
"type": "integer"
},
"numeric_scale": {
"type": "integer"
},
"ordinal_position": {
"type": "integer"
},
"scope_catalog": {
"type": "string"
},
"scope_name": {
"type": "string"
},
"scope_schema": {
"type": "string"
},
"udt_catalog": {
"type": "string"
},
"udt_name": {
"type": "string"
},
"udt_schema": {
"type": "string"
}
},
"type": "object"
}
}
} | Apache-2.0 | en |
codecrafters-io/legacy-course-sdk | d9dcc6525147947cac6d50353ee77c77d2bba86d | 2022-07-21T18:12:00 | schemas/course-definition.json | 10 | 2024-05-27T06:39:13.970143Z | {
"$id": "https://codecrafters.io/course-definition.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Schema for a CodeCrafters course definition",
"properties": {
"completion_percentage": {
"description": "Completion percentage of the course",
"type": "number"
},
"description_md": {
"description": "Description of the course in Markdown",
"type": "string"
},
"early_access_languages": {
"description": "Early access languages of the course",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "Name of the course",
"type": "string"
},
"release_status": {
"description": "Release status of the course",
"enum": [
"alpha",
"beta",
"live"
],
"type": "string"
},
"short_description_md": {
"description": "Short description of the course in Markdown",
"type": "string"
},
"short_name": {
"description": "Short name of the course",
"type": "string"
},
"slug": {
"description": "Slug of the course",
"type": "string"
},
"starter_repos": {
"type": "object"
},
"supported_languages": {
"description": "Supported languages of the course",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"slug",
"name",
"short_name",
"release_status"
],
"title": "CodeCrafters Course Definition",
"type": "object"
} | MIT | en |
xspeed1989/vcpkg_vc-ltl | 860a58fe2c58cd39b0b3a4ce146fce5bfde589c1 | 2023-03-25T12:46:15 | scripts/azure-pipelines/osx/configuration/vagrant-box-configuration.schema.json | 5 | 2024-05-29T09:51:47.740275Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"brew": {
"items": {
"type": "string"
},
"type": "array"
},
"brew-cask": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"brew",
"brew-cask"
],
"type": "object"
} | MIT | en |
xspeed1989/vcpkg_vc-ltl | 860a58fe2c58cd39b0b3a4ce146fce5bfde589c1 | 2023-03-25T12:46:15 | scripts/azure-pipelines/osx/configuration/installables.schema.json | 5 | 2024-05-29T09:51:47.740275Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"definitions": {
"sha256": {
"pattern": "[A-Z0-9]{64}",
"type": "string"
}
},
"properties": {
"Applications": {
"items": {
"properties": {
"DmgUrl": {
"format": "uri",
"type": "string"
},
"InstallerPath": {
"type": "string"
},
"Name": {
"type": "string"
},
"Sha256": {
"$ref": "#/definitions/sha256"
},
"Version": {
"type": "string"
},
"VersionCommand": {
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"VersionRegex": {
"format": "regex",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"VagrantPlugins": {
"items": {
"properties": {
"Name": {
"type": "string"
},
"Version": {
"type": "string"
}
},
"required": [
"Name",
"Version"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"Applications",
"VagrantPlugins"
],
"type": "object"
} | MIT | en |
xspeed1989/vcpkg_vc-ltl | 860a58fe2c58cd39b0b3a4ce146fce5bfde589c1 | 2023-03-25T12:46:15 | scripts/azure-pipelines/osx/configuration/vagrant-configuration.schema.json | 5 | 2024-05-29T09:51:47.740275Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"properties": {
"agent_pool": {
"type": "string"
},
"box_name": {
"type": "string"
},
"box_version": {
"type": "string"
},
"devops_url": {
"type": "string"
},
"machine_name": {
"type": "string"
},
"pat": {
"type": "string"
}
},
"required": [
"pat",
"agent_pool",
"devops_url",
"machine_name",
"box_name",
"box_version"
],
"type": "object"
} | MIT | en |
vdaas/vald | 16fb09f1edf1dd4d73226ef16b7609a8765b8300 | 2024-02-15T04:26:57 | charts/vald-benchmark-operator/schemas/job-values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"client_config": {
"description": "gRPC client config for request to the Vald cluster",
"properties": {
"addrs": {
"description": "gRPC client addresses",
"items": {
"type": "string"
},
"type": "array"
},
"backoff": {
"properties": {
"backoff_factor": {
"description": "gRPC client backoff factor",
"type": "number"
},
"backoff_time_limit": {
"description": "gRPC client backoff time limit",
"type": "string"
},
"enable_error_log": {
"description": "gRPC client backoff log enabled",
"type": "boolean"
},
"initial_duration": {
"description": "gRPC client backoff initial duration",
"type": "string"
},
"jitter_limit": {
"description": "gRPC client backoff jitter limit",
"type": "string"
},
"maximum_duration": {
"description": "gRPC client backoff maximum duration",
"type": "string"
},
"retry_count": {
"description": "gRPC client backoff retry count",
"type": "integer"
}
},
"type": "object"
},
"call_option": {
"type": "object"
},
"circuit_breaker": {
"properties": {
"closed_error_rate": {
"description": "gRPC client circuitbreaker closed error rate",
"type": "number"
},
"closed_refresh_timeout": {
"description": "gRPC client circuitbreaker closed refresh timeout",
"type": "string"
},
"half_open_error_rate": {
"description": "gRPC client circuitbreaker half-open error rate",
"type": "number"
},
"min_samples": {
"description": "gRPC client circuitbreaker minimum sampling count",
"type": "integer"
},
"open_timeout": {
"description": "gRPC client circuitbreaker open timeout",
"type": "string"
}
},
"type": "object"
},
"connection_pool": {
"properties": {
"enable_dns_resolver": {
"description": "enables gRPC client connection pool dns resolver, when enabled vald uses ip handshake exclude dns discovery which improves network performance",
"type": "boolean"
},
"enable_rebalance": {
"description": "enables gRPC client connection pool rebalance",
"type": "boolean"
},
"old_conn_close_duration": {
"description": "makes delay before gRPC client connection closing during connection pool rebalance",
"type": "string"
},
"rebalance_duration": {
"description": "gRPC client connection pool rebalance duration",
"type": "string"
},
"size": {
"description": "gRPC client connection pool size",
"type": "integer"
}
},
"type": "object"
},
"dial_option": {
"properties": {
"backoff_base_delay": {
"description": "gRPC client dial option base backoff delay",
"type": "string"
},
"backoff_jitter": {
"description": "gRPC client dial option base backoff delay",
"type": "number"
},
"backoff_max_delay": {
"description": "gRPC client dial option max backoff delay",
"type": "string"
},
"backoff_multiplier": {
"description": "gRPC client dial option base backoff delay",
"type": "number"
},
"enable_backoff": {
"description": "gRPC client dial option backoff enabled",
"type": "boolean"
},
"initial_connection_window_size": {
"description": "gRPC client dial option initial connection window size",
"type": "integer"
},
"initial_window_size": {
"description": "gRPC client dial option initial window size",
"type": "integer"
},
"insecure": {
"description": "gRPC client dial option insecure enabled",
"type": "boolean"
},
"interceptors": {
"description": "gRPC client interceptors",
"items": {
"enum": [
"TraceInterceptor"
],
"type": "string"
},
"type": "array"
},
"keepalive": {
"properties": {
"permit_without_stream": {
"description": "gRPC client keep alive permit without stream",
"type": "boolean"
},
"time": {
"description": "gRPC client keep alive time",
"type": "string"
},
"timeout": {
"description": "gRPC client keep alive timeout",
"type": "string"
}
},
"type": "object"
},
"max_msg_size": {
"description": "gRPC client dial option max message size",
"type": "integer"
},
"min_connection_timeout": {
"description": "gRPC client dial option minimum connection timeout",
"type": "string"
},
"net": {
"properties": {
"dialer": {
"properties": {
"dual_stack_enabled": {
"description": "gRPC client TCP dialer dual stack enabled",
"type": "boolean"
},
"keepalive": {
"description": "gRPC client TCP dialer keep alive",
"type": "string"
},
"timeout": {
"description": "gRPC client TCP dialer timeout",
"type": "string"
}
},
"type": "object"
},
"dns": {
"properties": {
"cache_enabled": {
"description": "gRPC client TCP DNS cache enabled",
"type": "boolean"
},
"cache_expiration": {
"description": "gRPC client TCP DNS cache expiration",
"type": "string"
},
"refresh_duration": {
"description": "gRPC client TCP DNS cache refresh duration",
"type": "string"
}
},
"type": "object"
},
"socket_option": {
"properties": {
"ip_recover_destination_addr": {
"description": "server listen socket option for ip_recover_destination_addr functionality",
"type": "boolean"
},
"ip_transparent": {
"description": "server listen socket option for ip_transparent functionality",
"type": "boolean"
},
"reuse_addr": {
"description": "server listen socket option for reuse_addr functionality",
"type": "boolean"
},
"reuse_port": {
"description": "server listen socket option for reuse_port functionality",
"type": "boolean"
},
"tcp_cork": {
"description": "server listen socket option for tcp_cork functionality",
"type": "boolean"
},
"tcp_defer_accept": {
"description": "server listen socket option for tcp_defer_accept functionality",
"type": "boolean"
},
"tcp_fast_open": {
"description": "server listen socket option for tcp_fast_open functionality",
"type": "boolean"
},
"tcp_no_delay": {
"description": "server listen socket option for tcp_no_delay functionality",
"type": "boolean"
},
"tcp_quick_ack": {
"description": "server listen socket option for tcp_quick_ack functionality",
"type": "boolean"
}
},
"type": "object"
},
"tls": {
"properties": {
"ca": {
"type": "string"
},
"cert": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"insecure_skip_verify": {
"type": "boolean"
},
"key": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"read_buffer_size": {
"description": "gRPC client dial option read buffer size",
"type": "integer"
},
"timeout": {
"description": "gRPC client dial option timeout",
"type": "string"
},
"write_buffer_size": {
"description": "gRPC client dial option write buffer size",
"type": "integer"
}
},
"type": "object"
},
"health_check_duration": {
"description": "gRPC client health check duration",
"type": "string"
},
"max_recv_msg_size": {
"type": "integer"
},
"max_retry_rpc_buffer_size": {
"type": "integer"
},
"max_send_msg_size": {
"type": "integer"
},
"tls": {
"properties": {
"ca": {
"description": "TLS ca path",
"type": "string"
},
"cert": {
"description": "TLS cert path",
"type": "string"
},
"enabled": {
"description": "TLS enabled",
"type": "boolean"
},
"insecure_skip_verify": {
"description": "enable/disable skip SSL certificate verification",
"type": "boolean"
},
"key": {
"description": "TLS key path",
"type": "string"
}
},
"type": "object"
},
"wait_for_ready": {
"type": "boolean"
}
},
"type": "object"
},
"concurrency_limit": {
"description": "concurrency_limit represents the goroutine limit count. It affects the job performance.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"dataset": {
"description": "dataset information",
"properties": {
"group": {
"description": "the hdf5 group name of dataset",
"minLength": 1,
"type": "string"
},
"indexes": {
"description": "the amount of indexes",
"minimum": 0,
"type": "integer"
},
"name": {
"description": "the name of dataset",
"enum": [
"original",
"fashion-mnist"
],
"type": "string"
},
"range": {
"description": "the data range of indexes",
"properties": {
"end": {
"description": "end index number",
"minimum": 1,
"type": "integer"
},
"start": {
"description": "start index number",
"minimum": 1,
"type": "integer"
}
},
"required": [
"start",
"end"
],
"type": "object"
},
"url": {
"description": "the dataset url which is used for executing benchmark job with user defined hdf5 file",
"type": "string"
}
},
"required": [
"name",
"indexes",
"group",
"range"
],
"type": "object"
},
"dimension": {
"description": "vector dimension",
"minimum": 1,
"type": "integer"
},
"global_config": {
"properties": {
"logging": {
"properties": {
"format": {
"enum": [
"raw",
"json"
],
"type": "string"
},
"level": {
"enum": [
"debug",
"info",
"warn",
"error",
"fatal"
],
"type": "string"
},
"logger": {
"enum": [
"glg",
"zap"
],
"type": "string"
}
},
"type": "object"
},
"time_zone": {
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"insert_config": {
"description": "insert config",
"properties": {
"skip_strict_exist_check": {
"description": "skip strict exists check flag config",
"type": "boolean"
},
"timestamp": {
"description": "index timestamp",
"type": "string"
}
},
"type": "object"
},
"job_type": {
"description": "job type name",
"enum": [
"insert",
"update",
"upsert",
"search",
"remove",
"getobject",
"exists"
],
"type": "string"
},
"object_config": {
"description": "object config",
"properties": {
"filter_config": {
"description": "filter target config",
"properties": {
"host": {
"description": "filter target host",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"remove_config": {
"description": "remove config",
"properties": {
"skip_strict_exist_check": {
"description": "skip strict exists check flag config",
"type": "boolean"
},
"timestamp": {
"description": "index timestamp",
"type": "string"
}
},
"type": "object"
},
"repetition": {
"description": "the number of repeat job",
"minimum": 1,
"type": "integer"
},
"replica": {
"description": "the number of running concurrency job",
"minimum": 1,
"type": "integer"
},
"rps": {
"description": "desired request per sec",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"rules": {
"description": "executing rule",
"items": {
"type": "string"
},
"type": "array"
},
"search_config": {
"description": "upsert config",
"properties": {
"aggregation_algorithm": {
"description": "search result aggregation algorithm",
"enum": [
"Unknown",
"ConcurrentQueue",
"SortSlice",
"SortPoolSlice",
"PairingHeap"
],
"type": "string"
},
"enable_linear_search": {
"description": "enable linear search for calculation recall",
"type": "boolean"
},
"epsilon": {
"description": "epsilon",
"type": "number"
},
"min_num": {
"description": "minimum number of top-k",
"type": "integer"
},
"num": {
"description": "number of top-k",
"type": "integer"
},
"radius": {
"description": "radius",
"type": "number"
},
"timeout": {
"description": "search operation timeout",
"type": "string"
}
},
"type": "object"
},
"server_config": {
"properties": {
"healths": {
"properties": {
"liveness": {
"properties": {
"enabled": {
"description": "liveness server enabled",
"type": "boolean"
},
"host": {
"description": "liveness server host",
"type": "string"
},
"livenessProbe": {
"properties": {
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "liveness probe path",
"type": "string"
},
"port": {
"description": "liveness probe port",
"type": "string"
},
"scheme": {
"description": "liveness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"port": {
"description": "liveness server port",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"server": {
"properties": {
"http": {
"properties": {
"handler_timeout": {
"description": "liveness server handler timeout",
"type": "string"
},
"idle_timeout": {
"description": "liveness server idle timeout",
"type": "string"
},
"read_header_timeout": {
"description": "liveness server read header timeout",
"type": "string"
},
"read_timeout": {
"description": "liveness server read timeout",
"type": "string"
},
"shutdown_duration": {
"description": "liveness server shutdown duration",
"type": "string"
},
"write_timeout": {
"description": "liveness server write timeout",
"type": "string"
}
},
"type": "object"
},
"mode": {
"description": "liveness server mode",
"type": "string"
},
"network": {
"description": "mysql network",
"enum": [
"tcp",
"tcp4",
"tcp6",
"udp",
"udp4",
"udp6",
"unix",
"unixgram",
"unixpacket"
],
"type": "string"
},
"probe_wait_time": {
"description": "liveness server probe wait time",
"type": "string"
},
"socket_option": {
"properties": {
"ip_recover_destination_addr": {
"description": "server listen socket option for ip_recover_destination_addr functionality",
"type": "boolean"
},
"ip_transparent": {
"description": "server listen socket option for ip_transparent functionality",
"type": "boolean"
},
"reuse_addr": {
"description": "server listen socket option for reuse_addr functionality",
"type": "boolean"
},
"reuse_port": {
"description": "server listen socket option for reuse_port functionality",
"type": "boolean"
},
"tcp_cork": {
"description": "server listen socket option for tcp_cork functionality",
"type": "boolean"
},
"tcp_defer_accept": {
"description": "server listen socket option for tcp_defer_accept functionality",
"type": "boolean"
},
"tcp_fast_open": {
"description": "server listen socket option for tcp_fast_open functionality",
"type": "boolean"
},
"tcp_no_delay": {
"description": "server listen socket option for tcp_no_delay functionality",
"type": "boolean"
},
"tcp_quick_ack": {
"description": "server listen socket option for tcp_quick_ack functionality",
"type": "boolean"
}
},
"type": "object"
},
"socket_path": {
"description": "mysql socket_path",
"type": "string"
}
},
"type": "object"
},
"servicePort": {
"description": "liveness server service port",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"readiness": {
"properties": {
"enabled": {
"description": "readiness server enabled",
"type": "boolean"
},
"host": {
"description": "readiness server host",
"type": "string"
},
"port": {
"description": "readiness server port",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"readinessProbe": {
"properties": {
"failureThreshold": {
"description": "readiness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "readiness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "readiness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "readiness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "readiness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"server": {
"properties": {
"http": {
"properties": {
"handler_timeout": {
"description": "readiness server handler timeout",
"type": "string"
},
"idle_timeout": {
"description": "readiness server idle timeout",
"type": "string"
},
"read_header_timeout": {
"description": "readiness server read header timeout",
"type": "string"
},
"read_timeout": {
"description": "readiness server read timeout",
"type": "string"
},
"shutdown_duration": {
"description": "readiness server shutdown duration",
"type": "string"
},
"write_timeout": {
"description": "readiness server write timeout",
"type": "string"
}
},
"type": "object"
},
"mode": {
"description": "readiness server mode",
"type": "string"
},
"network": {
"description": "mysql network",
"enum": [
"tcp",
"tcp4",
"tcp6",
"udp",
"udp4",
"udp6",
"unix",
"unixgram",
"unixpacket"
],
"type": "string"
},
"probe_wait_time": {
"description": "readiness server probe wait time",
"type": "string"
},
"socket_option": {
"properties": {
"ip_recover_destination_addr": {
"description": "server listen socket option for ip_recover_destination_addr functionality",
"type": "boolean"
},
"ip_transparent": {
"description": "server listen socket option for ip_transparent functionality",
"type": "boolean"
},
"reuse_addr": {
"description": "server listen socket option for reuse_addr functionality",
"type": "boolean"
},
"reuse_port": {
"description": "server listen socket option for reuse_port functionality",
"type": "boolean"
},
"tcp_cork": {
"description": "server listen socket option for tcp_cork functionality",
"type": "boolean"
},
"tcp_defer_accept": {
"description": "server listen socket option for tcp_defer_accept functionality",
"type": "boolean"
},
"tcp_fast_open": {
"description": "server listen socket option for tcp_fast_open functionality",
"type": "boolean"
},
"tcp_no_delay": {
"description": "server listen socket option for tcp_no_delay functionality",
"type": "boolean"
},
"tcp_quick_ack": {
"description": "server listen socket option for tcp_quick_ack functionality",
"type": "boolean"
}
},
"type": "object"
},
"socket_path": {
"description": "mysql socket_path",
"type": "string"
}
},
"type": "object"
},
"servicePort": {
"description": "readiness server service port",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"startup": {
"properties": {
"enabled": {
"description": "startup server enabled",
"type": "boolean"
},
"port": {
"description": "startup server port",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"startupProbe": {
"properties": {
"failureThreshold": {
"description": "startup probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "startup probe path",
"type": "string"
},
"port": {
"description": "startup probe port",
"type": "string"
},
"scheme": {
"description": "startup probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "startup probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "startup probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "startup probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "startup probe timeout seconds",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"servers": {
"properties": {
"grpc": {
"properties": {
"enabled": {
"description": "gRPC server enabled",
"type": "boolean"
},
"host": {
"description": "gRPC server host",
"type": "string"
},
"port": {
"description": "gRPC server port",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"server": {
"properties": {
"grpc": {
"properties": {
"bidirectional_stream_concurrency": {
"description": "gRPC server bidirectional stream concurrency",
"type": "integer"
},
"connection_timeout": {
"description": "gRPC server connection timeout",
"type": "string"
},
"enable_reflection": {
"description": "gRPC server reflection option",
"type": "boolean"
},
"header_table_size": {
"description": "gRPC server header table size",
"type": "integer"
},
"initial_conn_window_size": {
"description": "gRPC server initial connection window size",
"type": "integer"
},
"initial_window_size": {
"description": "gRPC server initial window size",
"type": "integer"
},
"interceptors": {
"description": "gRPC server interceptors",
"items": {
"enum": [
"RecoverInterceptor",
"AccessLogInterceptor",
"TraceInterceptor",
"MetricInterceptor"
],
"type": "string"
},
"type": "array"
},
"keepalive": {
"properties": {
"max_conn_age": {
"description": "gRPC server keep alive max connection age",
"type": "string"
},
"max_conn_age_grace": {
"description": "gRPC server keep alive max connection age grace",
"type": "string"
},
"max_conn_idle": {
"description": "gRPC server keep alive max connection idle",
"type": "string"
},
"min_time": {
"description": "gRPC server keep alive min_time",
"type": "string"
},
"permit_without_stream": {
"description": "gRPC server keep alive permit_without_stream",
"type": "boolean"
},
"time": {
"description": "gRPC server keep alive time",
"type": "string"
},
"timeout": {
"description": "gRPC server keep alive timeout",
"type": "string"
}
},
"type": "object"
},
"max_header_list_size": {
"description": "gRPC server max header list size",
"type": "integer"
},
"max_receive_message_size": {
"description": "gRPC server max receive message size",
"type": "integer"
},
"max_send_message_size": {
"description": "gRPC server max send message size",
"type": "integer"
},
"read_buffer_size": {
"description": "gRPC server read buffer size",
"type": "integer"
},
"write_buffer_size": {
"description": "gRPC server write buffer size",
"type": "integer"
}
},
"type": "object"
},
"mode": {
"description": "gRPC server server mode",
"type": "string"
},
"network": {
"description": "mysql network",
"enum": [
"tcp",
"tcp4",
"tcp6",
"udp",
"udp4",
"udp6",
"unix",
"unixgram",
"unixpacket"
],
"type": "string"
},
"probe_wait_time": {
"description": "gRPC server probe wait time",
"type": "string"
},
"restart": {
"description": "gRPC server restart",
"type": "boolean"
},
"socket_option": {
"properties": {
"ip_recover_destination_addr": {
"description": "server listen socket option for ip_recover_destination_addr functionality",
"type": "boolean"
},
"ip_transparent": {
"description": "server listen socket option for ip_transparent functionality",
"type": "boolean"
},
"reuse_addr": {
"description": "server listen socket option for reuse_addr functionality",
"type": "boolean"
},
"reuse_port": {
"description": "server listen socket option for reuse_port functionality",
"type": "boolean"
},
"tcp_cork": {
"description": "server listen socket option for tcp_cork functionality",
"type": "boolean"
},
"tcp_defer_accept": {
"description": "server listen socket option for tcp_defer_accept functionality",
"type": "boolean"
},
"tcp_fast_open": {
"description": "server listen socket option for tcp_fast_open functionality",
"type": "boolean"
},
"tcp_no_delay": {
"description": "server listen socket option for tcp_no_delay functionality",
"type": "boolean"
},
"tcp_quick_ack": {
"description": "server listen socket option for tcp_quick_ack functionality",
"type": "boolean"
}
},
"type": "object"
},
"socket_path": {
"description": "mysql socket_path",
"type": "string"
}
},
"type": "object"
},
"servicePort": {
"description": "gRPC server service port",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"rest": {
"properties": {
"enabled": {
"description": "REST server enabled",
"type": "boolean"
},
"host": {
"description": "REST server host",
"type": "string"
},
"port": {
"description": "REST server port",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"server": {
"properties": {
"http": {
"properties": {
"handler_timeout": {
"description": "REST server handler timeout",
"type": "string"
},
"idle_timeout": {
"description": "REST server idle timeout",
"type": "string"
},
"read_header_timeout": {
"description": "REST server read header timeout",
"type": "string"
},
"read_timeout": {
"description": "REST server read timeout",
"type": "string"
},
"shutdown_duration": {
"description": "REST server shutdown duration",
"type": "string"
},
"write_timeout": {
"description": "REST server write timeout",
"type": "string"
}
},
"type": "object"
},
"mode": {
"description": "REST server server mode",
"type": "string"
},
"network": {
"description": "mysql network",
"enum": [
"tcp",
"tcp4",
"tcp6",
"udp",
"udp4",
"udp6",
"unix",
"unixgram",
"unixpacket"
],
"type": "string"
},
"probe_wait_time": {
"description": "REST server probe wait time",
"type": "string"
},
"socket_option": {
"properties": {
"ip_recover_destination_addr": {
"description": "server listen socket option for ip_recover_destination_addr functionality",
"type": "boolean"
},
"ip_transparent": {
"description": "server listen socket option for ip_transparent functionality",
"type": "boolean"
},
"reuse_addr": {
"description": "server listen socket option for reuse_addr functionality",
"type": "boolean"
},
"reuse_port": {
"description": "server listen socket option for reuse_port functionality",
"type": "boolean"
},
"tcp_cork": {
"description": "server listen socket option for tcp_cork functionality",
"type": "boolean"
},
"tcp_defer_accept": {
"description": "server listen socket option for tcp_defer_accept functionality",
"type": "boolean"
},
"tcp_fast_open": {
"description": "server listen socket option for tcp_fast_open functionality",
"type": "boolean"
},
"tcp_no_delay": {
"description": "server listen socket option for tcp_no_delay functionality",
"type": "boolean"
},
"tcp_quick_ack": {
"description": "server listen socket option for tcp_quick_ack functionality",
"type": "boolean"
}
},
"type": "object"
},
"socket_path": {
"description": "mysql socket_path",
"type": "string"
}
},
"type": "object"
},
"servicePort": {
"description": "REST server service port",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"target": {
"description": "target cluster location",
"properties": {
"host": {
"description": "target cluster host",
"minLength": 1,
"type": "string"
},
"port": {
"description": "target cluster port",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"required": [
"host",
"port"
],
"type": "object"
},
"ttl_seconds_after_finished": {
"description": "limits the lifetime of a Job that has finished execution.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"update_config": {
"description": "update config",
"properties": {
"disable_balance_update": {
"description": "disabled balance update flag",
"type": "boolean"
},
"skip_strict_exist_check": {
"description": "skip strict exists check flag config",
"type": "boolean"
},
"timestamp": {
"description": "index timestamp",
"type": "string"
}
},
"type": "object"
},
"upsert_config": {
"description": "upsert config",
"properties": {
"disable_balance_update": {
"description": "disabled balance update flag",
"type": "boolean"
},
"skip_strict_exist_check": {
"description": "skip strict exists check flag config",
"type": "boolean"
},
"timestamp": {
"description": "index timestamp",
"type": "string"
}
},
"type": "object"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | bf7921ecfc55d600ce5ef4a7b42efabe8cdce0d6 | 2023-01-24T05:55:38 | charts/vald-helm-operator/values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"affinity": {
"description": "affinity",
"type": "object"
},
"annotations": {
"description": "deployment annotations",
"type": "object"
},
"enableLeaderElection": {
"description": "enable leader election for controller manager.",
"type": "boolean"
},
"enableMetrics": {
"description": "enable metrics endpoint",
"type": "boolean"
},
"healthPort": {
"description": "port of health endpoint",
"type": "integer"
},
"image": {
"properties": {
"pullPolicy": {
"description": "image pull policy",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"description": "image repository",
"type": "string"
},
"tag": {
"description": "image tag",
"type": "string"
}
},
"type": "object"
},
"leaderElectionID": {
"description": "name of the configmap that is used for holding the leader lock.",
"type": "string"
},
"livenessProbe": {
"properties": {
"enabled": {
"description": "enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"logging": {
"properties": {
"format": {
"description": "logging format of operator (console or json)",
"enum": [
"console",
"json"
],
"type": "string"
},
"level": {
"description": "logging level of operator (debug, info, or error)",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
},
"stacktraceLevel": {
"description": "minimum log level triggers stacktrace generation",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
}
},
"type": "object"
},
"maxConcurrentReconciles": {
"description": "max number of concurrent reconciles",
"type": "integer"
},
"metricsPort": {
"description": "port of metrics endpoint",
"type": "integer"
},
"name": {
"description": "name of the deployment",
"type": "string"
},
"namespaced": {
"description": "if it is true, operator will behave as a namespace-scoped operator, if it is false, it will behave as a cluster-scoped operator.",
"type": "boolean"
},
"nodeSelector": {
"description": "node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"description": "pod annotations",
"type": "object"
},
"podSecurityContext": {
"description": "security context for pod",
"type": "object"
},
"rbac": {
"properties": {
"create": {
"description": "required roles and rolebindings will be created",
"type": "boolean"
},
"name": {
"description": "name of roles and rolebindings",
"type": "string"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"enabled": {
"description": "enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"reconcilePeriod": {
"description": "reconcile duration of operator",
"type": "string"
},
"replicas": {
"description": "number of replicas",
"type": "integer"
},
"resources": {
"description": "kubernetes resources of pod",
"type": "object"
},
"securityContext": {
"description": "security context for container",
"type": "object"
},
"service": {
"properties": {
"annotations": {
"description": "service annotations",
"type": "object"
},
"enabled": {
"description": "service enabled",
"type": "boolean"
},
"externalTrafficPolicy": {
"description": "external traffic policy (can be specified when service type is LoadBalancer or NodePort) : Cluster or Local",
"type": "string"
},
"labels": {
"description": "service labels",
"type": "object"
},
"type": {
"description": "service type: ClusterIP, LoadBalancer or NodePort",
"enum": [
"ClusterIP",
"LoadBalancer",
"NodePort"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"description": "service account will be created",
"type": "boolean"
},
"name": {
"description": "name of service account",
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"description": "tolerations",
"items": {
"type": "object"
},
"type": "array"
},
"watchNamespaces": {
"description": "comma separated names of namespaces to watch, if it is empty, the namespace that the operator exists in is used.",
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | 16fb09f1edf1dd4d73226ef16b7609a8765b8300 | 2024-02-15T04:26:57 | charts/vald-benchmark-operator/schemas/scenario-values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"dataset": {
"description": "dataset information",
"properties": {
"group": {
"description": "the hdf5 group name of dataset",
"minLength": 1,
"type": "string"
},
"indexes": {
"description": "the amount of indexes",
"minimum": 0,
"type": "integer"
},
"name": {
"description": "the name of dataset",
"enum": [
"original",
"fashion-mnist"
],
"type": "string"
},
"range": {
"description": "the data range of indexes",
"properties": {
"end": {
"description": "end index number",
"minimum": 1,
"type": "integer"
},
"start": {
"description": "start index number",
"minimum": 1,
"type": "integer"
}
},
"required": [
"start",
"end"
],
"type": "object"
},
"url": {
"description": "the dataset url which is used for executing benchmark job with user defined hdf5 file",
"type": "string"
}
},
"required": [
"name",
"indexes",
"group",
"range"
],
"type": "object"
},
"jobs": {
"items": {
"type": "object"
},
"type": "array"
},
"target": {
"description": "target cluster location",
"properties": {
"host": {
"description": "target cluster host",
"minLength": 1,
"type": "string"
},
"port": {
"description": "target cluster port",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"required": [
"host",
"port"
],
"type": "object"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | 511bf0177b7b7098e7b4c04eadf8efd00336c56a | 2023-02-09T08:05:46 | charts/vald-helm-operator/values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"affinity": {
"description": "affinity",
"type": "object"
},
"annotations": {
"description": "deployment annotations",
"type": "object"
},
"enableLeaderElection": {
"description": "enable leader election for controller manager.",
"type": "boolean"
},
"enableMetrics": {
"description": "enable metrics endpoint",
"type": "boolean"
},
"healthPort": {
"description": "port of health endpoint",
"type": "integer"
},
"image": {
"properties": {
"pullPolicy": {
"description": "image pull policy",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"description": "image repository",
"type": "string"
},
"tag": {
"description": "image tag",
"type": "string"
}
},
"type": "object"
},
"leaderElectionID": {
"description": "name of the configmap that is used for holding the leader lock.",
"type": "string"
},
"livenessProbe": {
"properties": {
"enabled": {
"description": "enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"logging": {
"properties": {
"format": {
"description": "logging format of operator (console or json)",
"enum": [
"console",
"json"
],
"type": "string"
},
"level": {
"description": "logging level of operator (debug, info, or error)",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
},
"stacktraceLevel": {
"description": "minimum log level triggers stacktrace generation",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
}
},
"type": "object"
},
"maxConcurrentReconciles": {
"description": "max number of concurrent reconciles",
"type": "integer"
},
"metricsPort": {
"description": "port of metrics endpoint",
"type": "integer"
},
"name": {
"description": "name of the deployment",
"type": "string"
},
"namespaced": {
"description": "if it is true, operator will behave as a namespace-scoped operator, if it is false, it will behave as a cluster-scoped operator.",
"type": "boolean"
},
"nodeSelector": {
"description": "node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"description": "pod annotations",
"type": "object"
},
"podSecurityContext": {
"description": "security context for pod",
"type": "object"
},
"rbac": {
"properties": {
"create": {
"description": "required roles and rolebindings will be created",
"type": "boolean"
},
"name": {
"description": "name of roles and rolebindings",
"type": "string"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"enabled": {
"description": "enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"reconcilePeriod": {
"description": "reconcile duration of operator",
"type": "string"
},
"replicas": {
"description": "number of replicas",
"type": "integer"
},
"resources": {
"description": "kubernetes resources of pod",
"type": "object"
},
"securityContext": {
"description": "security context for container",
"type": "object"
},
"service": {
"properties": {
"annotations": {
"description": "service annotations",
"type": "object"
},
"enabled": {
"description": "service enabled",
"type": "boolean"
},
"externalTrafficPolicy": {
"description": "external traffic policy (can be specified when service type is LoadBalancer or NodePort) : Cluster or Local",
"type": "string"
},
"labels": {
"description": "service labels",
"type": "object"
},
"type": {
"description": "service type: ClusterIP, LoadBalancer or NodePort",
"enum": [
"ClusterIP",
"LoadBalancer",
"NodePort"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"description": "service account will be created",
"type": "boolean"
},
"name": {
"description": "name of service account",
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"description": "tolerations",
"items": {
"type": "object"
},
"type": "array"
},
"watchNamespaces": {
"description": "comma separated names of namespaces to watch, if it is empty, the namespace that the operator exists in is used.",
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | 6d4b50543c6a900594aabca3a44b160fd27964d9 | 2024-05-08T06:49:30 | charts/vald-benchmark-operator/values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"affinity": {
"description": "affinity",
"type": "object"
},
"annotations": {
"description": "deployment annotations",
"type": "object"
},
"env": {
"description": "environment variables",
"items": {
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"description": "image pull policy",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"description": "job image repository",
"type": "string"
},
"tag": {
"description": "image tag for job docker image",
"type": "string"
}
},
"type": "object"
},
"job": {
"properties": {
"client_config": {
"properties": {
"addrs": {
"description": "gRPC client addresses",
"items": {
"type": "string"
},
"type": "array"
},
"backoff": {
"properties": {
"backoff_factor": {
"description": "gRPC client backoff factor",
"type": "number"
},
"backoff_time_limit": {
"description": "gRPC client backoff time limit",
"type": "string"
},
"enable_error_log": {
"description": "gRPC client backoff log enabled",
"type": "boolean"
},
"initial_duration": {
"description": "gRPC client backoff initial duration",
"type": "string"
},
"jitter_limit": {
"description": "gRPC client backoff jitter limit",
"type": "string"
},
"maximum_duration": {
"description": "gRPC client backoff maximum duration",
"type": "string"
},
"retry_count": {
"description": "gRPC client backoff retry count",
"type": "integer"
}
},
"type": "object"
},
"call_option": {
"type": "object"
},
"circuit_breaker": {
"properties": {
"closed_error_rate": {
"description": "gRPC client circuitbreaker closed error rate",
"type": "number"
},
"closed_refresh_timeout": {
"description": "gRPC client circuitbreaker closed refresh timeout",
"type": "string"
},
"half_open_error_rate": {
"description": "gRPC client circuitbreaker half-open error rate",
"type": "number"
},
"min_samples": {
"description": "gRPC client circuitbreaker minimum sampling count",
"type": "integer"
},
"open_timeout": {
"description": "gRPC client circuitbreaker open timeout",
"type": "string"
}
},
"type": "object"
},
"connection_pool": {
"properties": {
"enable_dns_resolver": {
"description": "enables gRPC client connection pool dns resolver, when enabled vald uses ip handshake exclude dns discovery which improves network performance",
"type": "boolean"
},
"enable_rebalance": {
"description": "enables gRPC client connection pool rebalance",
"type": "boolean"
},
"old_conn_close_duration": {
"description": "makes delay before gRPC client connection closing during connection pool rebalance",
"type": "string"
},
"rebalance_duration": {
"description": "gRPC client connection pool rebalance duration",
"type": "string"
},
"size": {
"description": "gRPC client connection pool size",
"type": "integer"
}
},
"type": "object"
},
"dial_option": {
"properties": {
"backoff_base_delay": {
"description": "gRPC client dial option base backoff delay",
"type": "string"
},
"backoff_jitter": {
"description": "gRPC client dial option base backoff delay",
"type": "number"
},
"backoff_max_delay": {
"description": "gRPC client dial option max backoff delay",
"type": "string"
},
"backoff_multiplier": {
"description": "gRPC client dial option base backoff delay",
"type": "number"
},
"enable_backoff": {
"description": "gRPC client dial option backoff enabled",
"type": "boolean"
},
"initial_connection_window_size": {
"description": "gRPC client dial option initial connection window size",
"type": "integer"
},
"initial_window_size": {
"description": "gRPC client dial option initial window size",
"type": "integer"
},
"insecure": {
"description": "gRPC client dial option insecure enabled",
"type": "boolean"
},
"interceptors": {
"description": "gRPC client interceptors",
"items": {
"enum": [
"TraceInterceptor"
],
"type": "string"
},
"type": "array"
},
"keepalive": {
"properties": {
"permit_without_stream": {
"description": "gRPC client keep alive permit without stream",
"type": "boolean"
},
"time": {
"description": "gRPC client keep alive time",
"type": "string"
},
"timeout": {
"description": "gRPC client keep alive timeout",
"type": "string"
}
},
"type": "object"
},
"max_msg_size": {
"description": "gRPC client dial option max message size",
"type": "integer"
},
"min_connection_timeout": {
"description": "gRPC client dial option minimum connection timeout",
"type": "string"
},
"net": {
"properties": {
"dialer": {
"properties": {
"dual_stack_enabled": {
"description": "gRPC client TCP dialer dual stack enabled",
"type": "boolean"
},
"keepalive": {
"description": "gRPC client TCP dialer keep alive",
"type": "string"
},
"timeout": {
"description": "gRPC client TCP dialer timeout",
"type": "string"
}
},
"type": "object"
},
"dns": {
"properties": {
"cache_enabled": {
"description": "gRPC client TCP DNS cache enabled",
"type": "boolean"
},
"cache_expiration": {
"description": "gRPC client TCP DNS cache expiration",
"type": "string"
},
"refresh_duration": {
"description": "gRPC client TCP DNS cache refresh duration",
"type": "string"
}
},
"type": "object"
},
"socket_option": {
"properties": {
"ip_recover_destination_addr": {
"description": "server listen socket option for ip_recover_destination_addr functionality",
"type": "boolean"
},
"ip_transparent": {
"description": "server listen socket option for ip_transparent functionality",
"type": "boolean"
},
"reuse_addr": {
"description": "server listen socket option for reuse_addr functionality",
"type": "boolean"
},
"reuse_port": {
"description": "server listen socket option for reuse_port functionality",
"type": "boolean"
},
"tcp_cork": {
"description": "server listen socket option for tcp_cork functionality",
"type": "boolean"
},
"tcp_defer_accept": {
"description": "server listen socket option for tcp_defer_accept functionality",
"type": "boolean"
},
"tcp_fast_open": {
"description": "server listen socket option for tcp_fast_open functionality",
"type": "boolean"
},
"tcp_no_delay": {
"description": "server listen socket option for tcp_no_delay functionality",
"type": "boolean"
},
"tcp_quick_ack": {
"description": "server listen socket option for tcp_quick_ack functionality",
"type": "boolean"
}
},
"type": "object"
},
"tls": {
"properties": {
"ca": {
"type": "string"
},
"cert": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"insecure_skip_verify": {
"type": "boolean"
},
"key": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"read_buffer_size": {
"description": "gRPC client dial option read buffer size",
"type": "integer"
},
"timeout": {
"description": "gRPC client dial option timeout",
"type": "string"
},
"write_buffer_size": {
"description": "gRPC client dial option write buffer size",
"type": "integer"
}
},
"type": "object"
},
"health_check_duration": {
"description": "gRPC client health check duration",
"type": "string"
},
"max_recv_msg_size": {
"type": "integer"
},
"max_retry_rpc_buffer_size": {
"type": "integer"
},
"max_send_msg_size": {
"type": "integer"
},
"tls": {
"properties": {
"ca": {
"description": "TLS ca path",
"type": "string"
},
"cert": {
"description": "TLS cert path",
"type": "string"
},
"enabled": {
"description": "TLS enabled",
"type": "boolean"
},
"insecure_skip_verify": {
"description": "enable/disable skip SSL certificate verification",
"type": "boolean"
},
"key": {
"description": "TLS key path",
"type": "string"
}
},
"type": "object"
},
"wait_for_ready": {
"type": "boolean"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"logging": {
"properties": {
"format": {
"description": "logging format. logging format must be `raw` or `json`",
"enum": [
"raw",
"json"
],
"type": "string"
},
"level": {
"description": "logging level. logging level must be `debug`, `info`, `warn`, `error` or `fatal`.",
"enum": [
"debug",
"info",
"warn",
"error",
"fatal"
],
"type": "string"
},
"logger": {
"description": "logger name. currently logger must be `glg` or `zap`.",
"enum": [
"glg",
"zap"
],
"type": "string"
}
},
"type": "object"
},
"name": {
"description": "name of the deployment",
"type": "string"
},
"nodeSelector": {
"description": "node labels for pod assignment",
"type": "object"
},
"observability": {
"properties": {
"enabled": {
"type": "boolean"
},
"otlp": {
"properties": {
"attribute": {
"properties": {
"metrics": {
"properties": {
"enable_cgo": {
"type": "boolean"
},
"enable_goroutine": {
"type": "boolean"
},
"enable_memory": {
"type": "boolean"
},
"enable_version_info": {
"type": "boolean"
},
"version_info_labels": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"namespace": {
"type": "string"
},
"node_name": {
"type": "string"
},
"pod_name": {
"type": "string"
},
"service_name": {
"type": "string"
}
},
"type": "object"
},
"collector_endpoint": {
"type": "string"
},
"metrics_export_interval": {
"type": "string"
},
"metrics_export_timeout": {
"type": "string"
},
"trace_batch_timeout": {
"type": "string"
},
"trace_export_timeout": {
"type": "string"
},
"trace_max_export_batch_size": {
"type": "integer"
},
"trace_max_queue_size": {
"type": "integer"
}
},
"type": "object"
},
"trace": {
"properties": {
"enabled": {
"type": "boolean"
},
"sampling_rate": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"podAnnotations": {
"description": "pod annotations",
"type": "object"
},
"podSecurityContext": {
"description": "security context for pod",
"type": "object"
},
"rbac": {
"properties": {
"create": {
"description": "required roles and rolebindings will be created",
"type": "boolean"
},
"name": {
"description": "name of roles and rolebindings",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "the number of replica for deployment",
"type": "integer"
},
"resources": {
"description": "kubernetes resources of pod",
"properties": {
"limits": {
"type": "object"
},
"requests": {
"type": "object"
}
},
"type": "object"
},
"securityContext": {
"description": "security context for container",
"type": "object"
},
"server_config": {
"properties": {
"full_shutdown_duration": {
"type": "string"
},
"healths": {
"properties": {
"liveness": {
"properties": {
"enabled": {
"type": "boolean"
},
"host": {
"type": "string"
},
"livenessProbe": {
"properties": {
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"port": {
"type": "integer"
},
"server": {
"properties": {
"http": {
"properties": {
"idle_timeout": {
"type": "string"
},
"read_header_timeout": {
"type": "string"
},
"read_timeout": {
"type": "string"
},
"shutdown_duration": {
"type": "string"
},
"timeout": {
"type": "string"
},
"write_timeout": {
"type": "string"
}
},
"type": "object"
},
"mode": {
"type": "string"
},
"network": {
"type": "string"
},
"probe_wait_time": {
"type": "string"
},
"socket_path": {
"type": "string"
}
},
"type": "object"
},
"servicePort": {
"type": "integer"
}
},
"type": "object"
},
"readiness": {
"properties": {
"enabled": {
"type": "boolean"
},
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"readinessProbe": {
"properties": {
"failureThreshold": {
"description": "readiness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "readiness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "readiness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "readiness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "readiness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"server": {
"properties": {
"http": {
"properties": {
"handler_timeout": {
"type": "string"
},
"idle_timeout": {
"type": "string"
},
"read_header_timeout": {
"type": "string"
},
"read_timeout": {
"type": "string"
},
"shutdown_duration": {
"type": "string"
},
"write_timeout": {
"type": "string"
}
},
"type": "object"
},
"mode": {
"type": "string"
},
"network": {
"type": "string"
},
"probe_wait_time": {
"type": "string"
},
"socket_path": {
"type": "string"
}
},
"type": "object"
},
"servicePort": {
"type": "integer"
}
},
"type": "object"
},
"startup": {
"properties": {
"enabled": {
"description": "enable startup probe.",
"type": "boolean"
}
},
"type": "object"
},
"startupProbe": {
"properties": {
"failureThreshold": {
"description": "startupProbe probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "startup probe path",
"type": "string"
},
"port": {
"description": "startup probe port",
"type": "string"
},
"scheme": {
"description": "startup probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "startup probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "startup probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "startup probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "startup probe timeout seconds",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"metrics": {
"properties": {
"pprof": {
"properties": {
"enabled": {
"type": "boolean"
},
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"server": {
"properties": {
"http": {
"properties": {
"handler_timeout": {
"type": "string"
},
"idle_timeout": {
"type": "string"
},
"read_header_timeout": {
"type": "string"
},
"read_timeout": {
"type": "string"
},
"shutdown_duration": {
"type": "string"
},
"write_timeout": {
"type": "string"
}
},
"type": "object"
},
"mode": {
"type": "string"
},
"network": {
"type": "string"
},
"probe_wait_time": {
"type": "string"
},
"socket_path": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"servers": {
"properties": {
"grpc": {
"properties": {
"enabled": {
"type": "boolean"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"port": {
"type": "integer"
},
"server": {
"properties": {
"grpc": {
"properties": {
"bidirectional_stream_concurrency": {
"type": "integer"
},
"connection_timeout": {
"type": "string"
},
"enable_reflection": {
"type": "boolean"
},
"header_table_size": {
"type": "integer"
},
"initial_conn_window_size": {
"type": "integer"
},
"initial_window_size": {
"type": "integer"
},
"interceptors": {
"items": {
"type": "string"
},
"type": "array"
},
"keepalive": {
"properties": {
"max_conn_age": {
"description": "gRPC server keep alive max connection age",
"type": "string"
},
"max_conn_age_grace": {
"description": "gRPC server keep alive max connection age grace",
"type": "string"
},
"max_conn_idle": {
"description": "gRPC server keep alive max connection idle",
"type": "string"
},
"min_time": {
"description": "gRPC server keep alive min_time",
"type": "string"
},
"permit_without_stream": {
"description": "gRPC server keep alive permit_without_stream",
"type": "boolean"
},
"time": {
"description": "gRPC server keep alive time",
"type": "string"
},
"timeout": {
"description": "gRPC server keep alive timeout",
"type": "string"
}
},
"type": "object"
},
"max_header_list_size": {
"type": "integer"
},
"max_receive_message_size": {
"type": "integer"
},
"max_send_msg_size": {
"type": "integer"
},
"read_buffer_size": {
"type": "integer"
},
"write_buffer_size": {
"type": "integer"
}
},
"type": "object"
},
"mode": {
"type": "string"
},
"network": {
"type": "string"
},
"probe_wait_time": {
"type": "string"
},
"restart": {
"type": "boolean"
},
"socket_path": {
"type": "string"
}
},
"type": "object"
},
"servicePort": {
"type": "integer"
}
},
"type": "object"
},
"rest": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"tls": {
"properties": {
"ca": {
"type": "string"
},
"cert": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"insecure_skip_verify": {
"description": "enable/disable skip SSL certificate verification",
"type": "boolean"
},
"key": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"annotations": {
"description": "service annotations",
"type": "object"
},
"enabled": {
"description": "service enabled",
"type": "boolean"
},
"externalTrafficPolicy": {
"description": "external traffic policy (can be specified when service type is LoadBalancer or NodePort) : Cluster or Local",
"type": "string"
},
"labels": {
"description": "service labels",
"type": "object"
},
"type": {
"description": "service type: ClusterIP, LoadBalancer or NodePort",
"enum": [
"ClusterIP",
"LoadBalancer",
"NodePort"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"description": "service account will be created",
"type": "boolean"
},
"name": {
"description": "name of service account",
"type": "string"
}
},
"type": "object"
},
"time_zone": {
"description": "time_zone",
"type": "string"
},
"tolerations": {
"description": "tolerations",
"items": {
"type": "object"
},
"type": "array"
},
"version": {
"description": "version of benchmark-operator config",
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | 3c0fe398d12d59e7551918b2c9b422b2271d6933 | 2021-04-06T09:39:32 | charts/vald-helm-operator/values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"affinity": {
"description": "affinity",
"type": "object"
},
"annotations": {
"description": "deployment annotations",
"type": "object"
},
"enableLeaderElection": {
"description": "enable leader election for controller manager.",
"type": "boolean"
},
"enableMetrics": {
"description": "enable metrics endpoint",
"type": "boolean"
},
"healthPort": {
"description": "port of health endpoint",
"type": "integer"
},
"image": {
"properties": {
"pullPolicy": {
"description": "image pull policy",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"description": "image repository",
"type": "string"
},
"tag": {
"description": "image tag",
"type": "string"
}
},
"type": "object"
},
"leaderElectionID": {
"description": "name of the configmap that is used for holding the leader lock.",
"type": "string"
},
"livenessProbe": {
"properties": {
"enabled": {
"description": "enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"logging": {
"properties": {
"format": {
"description": "logging format of operator (console or json)",
"enum": [
"console",
"json"
],
"type": "string"
},
"level": {
"description": "logging level of operator (debug, info, or error)",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
},
"stacktraceLevel": {
"description": "minimum log level triggers stacktrace generation",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
}
},
"type": "object"
},
"maxConcurrentReconciles": {
"description": "max number of concurrent reconciles",
"type": "integer"
},
"metricsPort": {
"description": "port of metrics endpoint",
"type": "integer"
},
"name": {
"description": "name of the deployment",
"type": "string"
},
"namespaced": {
"description": "if it is true, operator will behave as a namespace-scoped operator, if it is false, it will behave as a cluster-scoped operator.",
"type": "boolean"
},
"nodeSelector": {
"description": "node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"description": "pod annotations",
"type": "object"
},
"rbac": {
"properties": {
"create": {
"description": "required roles and rolebindings will be created",
"type": "boolean"
},
"name": {
"description": "name of roles and rolebindings",
"type": "string"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"enabled": {
"description": "enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"reconcilePeriod": {
"description": "reconcile duration of operator",
"type": "string"
},
"replicas": {
"description": "number of replicas",
"type": "integer"
},
"resources": {
"description": "kubernetes resources of pod",
"type": "object"
},
"service": {
"properties": {
"annotations": {
"description": "service annotations",
"type": "object"
},
"enabled": {
"description": "service enabled",
"type": "boolean"
},
"externalTrafficPolicy": {
"description": "external traffic policy (can be specified when service type is LoadBalancer or NodePort) : Cluster or Local",
"type": "string"
},
"labels": {
"description": "service labels",
"type": "object"
},
"type": {
"description": "service type: ClusterIP, LoadBalancer or NodePort",
"enum": [
"ClusterIP",
"LoadBalancer",
"NodePort"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"description": "service account will be created",
"type": "boolean"
},
"name": {
"description": "name of service account",
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"description": "tolerations",
"items": {
"type": "object"
},
"type": "array"
},
"watchNamespaces": {
"description": "comma separated names of namespaces to watch, if it is empty, the namespace that the operator exists in is used.",
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | 033c2a6921ea3bb1885964d804c13787e4d6f61a | 2020-09-03T06:34:04 | charts/vald-helm-operator/values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"affinity": {
"type": "object"
},
"annotations": {
"type": "object"
},
"enableLeaderElection": {
"type": "boolean"
},
"enableMetrics": {
"type": "boolean"
},
"image": {
"properties": {
"pullPolicy": {
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"type": "object"
},
"leaderElectionID": {
"type": "string"
},
"logging": {
"properties": {
"format": {
"enum": [
"console",
"json"
],
"type": "string"
},
"level": {
"enum": [
"debug",
"info",
"error"
],
"type": "string"
},
"stacktraceLevel": {
"enum": [
"debug",
"info",
"error"
],
"type": "string"
}
},
"type": "object"
},
"maxConcurrentReconciles": {
"type": "integer"
},
"metricsPort": {
"type": "integer"
},
"name": {
"type": "string"
},
"namespaced": {
"type": "boolean"
},
"nodeSelector": {
"type": "object"
},
"podAnnotations": {
"type": "object"
},
"rbac": {
"properties": {
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"reconcilePeriod": {
"type": "string"
},
"replicas": {
"type": "integer"
},
"resources": {
"type": "object"
},
"service": {
"properties": {
"annotations": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"externalTrafficPolicy": {
"type": "string"
},
"labels": {
"type": "object"
},
"type": {
"enum": [
"ClusterIP",
"LoadBalancer",
"NodePort"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"items": {
"type": "object"
},
"type": "array"
},
"watchNamespaces": {
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | bb8e8dc82e1dc8e17515c94f17931e491c2bcd04 | 2023-06-15T06:18:07 | charts/vald-helm-operator/values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"affinity": {
"description": "affinity",
"type": "object"
},
"annotations": {
"description": "deployment annotations",
"type": "object"
},
"enableLeaderElection": {
"description": "enable leader election for controller manager.",
"type": "boolean"
},
"enableMetrics": {
"description": "enable metrics endpoint",
"type": "boolean"
},
"healthPort": {
"description": "port of health endpoint",
"type": "integer"
},
"image": {
"properties": {
"pullPolicy": {
"description": "image pull policy",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"description": "image repository",
"type": "string"
},
"tag": {
"description": "image tag",
"type": "string"
}
},
"type": "object"
},
"leaderElectionID": {
"description": "name of the configmap that is used for holding the leader lock.",
"type": "string"
},
"livenessProbe": {
"properties": {
"enabled": {
"description": "enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"logging": {
"properties": {
"format": {
"description": "logging format of operator (console or json)",
"enum": [
"console",
"json"
],
"type": "string"
},
"level": {
"description": "logging level of operator (debug, info, or error)",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
},
"stacktraceLevel": {
"description": "minimum log level triggers stacktrace generation",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
}
},
"type": "object"
},
"maxConcurrentReconciles": {
"description": "max number of concurrent reconciles",
"type": "integer"
},
"metricsPort": {
"description": "port of metrics endpoint",
"type": "integer"
},
"name": {
"description": "name of the deployment",
"type": "string"
},
"namespaced": {
"description": "if it is true, operator will behave as a namespace-scoped operator, if it is false, it will behave as a cluster-scoped operator.",
"type": "boolean"
},
"nodeSelector": {
"description": "node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"description": "pod annotations",
"type": "object"
},
"podSecurityContext": {
"description": "security context for pod",
"type": "object"
},
"rbac": {
"properties": {
"create": {
"description": "required roles and rolebindings will be created",
"type": "boolean"
},
"name": {
"description": "name of roles and rolebindings",
"type": "string"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"enabled": {
"description": "enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"reconcilePeriod": {
"description": "reconcile duration of operator",
"type": "string"
},
"replicas": {
"description": "number of replicas",
"type": "integer"
},
"resources": {
"description": "kubernetes resources of pod",
"type": "object"
},
"securityContext": {
"description": "security context for container",
"type": "object"
},
"service": {
"properties": {
"annotations": {
"description": "service annotations",
"type": "object"
},
"enabled": {
"description": "service enabled",
"type": "boolean"
},
"externalTrafficPolicy": {
"description": "external traffic policy (can be specified when service type is LoadBalancer or NodePort) : Cluster or Local",
"type": "string"
},
"labels": {
"description": "service labels",
"type": "object"
},
"type": {
"description": "service type: ClusterIP, LoadBalancer or NodePort",
"enum": [
"ClusterIP",
"LoadBalancer",
"NodePort"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"description": "service account will be created",
"type": "boolean"
},
"name": {
"description": "name of service account",
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"description": "tolerations",
"items": {
"type": "object"
},
"type": "array"
},
"watchNamespaces": {
"description": "comma separated names of namespaces to watch, if it is empty, the namespace that the operator exists in is used.",
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | 00f179325cde95e668e3b4b3d08010e486a146f3 | 2023-06-12T07:11:51 | charts/vald-helm-operator/values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"affinity": {
"description": "affinity",
"type": "object"
},
"annotations": {
"description": "deployment annotations",
"type": "object"
},
"enableLeaderElection": {
"description": "enable leader election for controller manager.",
"type": "boolean"
},
"enableMetrics": {
"description": "enable metrics endpoint",
"type": "boolean"
},
"healthPort": {
"description": "port of health endpoint",
"type": "integer"
},
"image": {
"properties": {
"pullPolicy": {
"description": "image pull policy",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"description": "image repository",
"type": "string"
},
"tag": {
"description": "image tag",
"type": "string"
}
},
"type": "object"
},
"leaderElectionID": {
"description": "name of the configmap that is used for holding the leader lock.",
"type": "string"
},
"livenessProbe": {
"properties": {
"enabled": {
"description": "enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"logging": {
"properties": {
"format": {
"description": "logging format of operator (console or json)",
"enum": [
"console",
"json"
],
"type": "string"
},
"level": {
"description": "logging level of operator (debug, info, or error)",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
},
"stacktraceLevel": {
"description": "minimum log level triggers stacktrace generation",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
}
},
"type": "object"
},
"maxConcurrentReconciles": {
"description": "max number of concurrent reconciles",
"type": "integer"
},
"metricsPort": {
"description": "port of metrics endpoint",
"type": "integer"
},
"name": {
"description": "name of the deployment",
"type": "string"
},
"namespaced": {
"description": "if it is true, operator will behave as a namespace-scoped operator, if it is false, it will behave as a cluster-scoped operator.",
"type": "boolean"
},
"nodeSelector": {
"description": "node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"description": "pod annotations",
"type": "object"
},
"podSecurityContext": {
"description": "security context for pod",
"type": "object"
},
"rbac": {
"properties": {
"create": {
"description": "required roles and rolebindings will be created",
"type": "boolean"
},
"name": {
"description": "name of roles and rolebindings",
"type": "string"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"enabled": {
"description": "enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"reconcilePeriod": {
"description": "reconcile duration of operator",
"type": "string"
},
"replicas": {
"description": "number of replicas",
"type": "integer"
},
"resources": {
"description": "kubernetes resources of pod",
"type": "object"
},
"securityContext": {
"description": "security context for container",
"type": "object"
},
"service": {
"properties": {
"annotations": {
"description": "service annotations",
"type": "object"
},
"enabled": {
"description": "service enabled",
"type": "boolean"
},
"externalTrafficPolicy": {
"description": "external traffic policy (can be specified when service type is LoadBalancer or NodePort) : Cluster or Local",
"type": "string"
},
"labels": {
"description": "service labels",
"type": "object"
},
"type": {
"description": "service type: ClusterIP, LoadBalancer or NodePort",
"enum": [
"ClusterIP",
"LoadBalancer",
"NodePort"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"description": "service account will be created",
"type": "boolean"
},
"name": {
"description": "name of service account",
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"description": "tolerations",
"items": {
"type": "object"
},
"type": "array"
},
"watchNamespaces": {
"description": "comma separated names of namespaces to watch, if it is empty, the namespace that the operator exists in is used.",
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | cb1d4019cfa2c4c620151475e7f7ebdea1ab629a | 2023-06-15T07:05:54 | charts/vald-helm-operator/values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"affinity": {
"description": "affinity",
"type": "object"
},
"annotations": {
"description": "deployment annotations",
"type": "object"
},
"enableLeaderElection": {
"description": "enable leader election for controller manager.",
"type": "boolean"
},
"enableMetrics": {
"description": "enable metrics endpoint",
"type": "boolean"
},
"healthPort": {
"description": "port of health endpoint",
"type": "integer"
},
"image": {
"properties": {
"pullPolicy": {
"description": "image pull policy",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"description": "image repository",
"type": "string"
},
"tag": {
"description": "image tag",
"type": "string"
}
},
"type": "object"
},
"leaderElectionID": {
"description": "name of the configmap that is used for holding the leader lock.",
"type": "string"
},
"livenessProbe": {
"properties": {
"enabled": {
"description": "enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"logging": {
"properties": {
"format": {
"description": "logging format of operator (console or json)",
"enum": [
"console",
"json"
],
"type": "string"
},
"level": {
"description": "logging level of operator (debug, info, or error)",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
},
"stacktraceLevel": {
"description": "minimum log level triggers stacktrace generation",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
}
},
"type": "object"
},
"maxConcurrentReconciles": {
"description": "max number of concurrent reconciles",
"type": "integer"
},
"metricsPort": {
"description": "port of metrics endpoint",
"type": "integer"
},
"name": {
"description": "name of the deployment",
"type": "string"
},
"namespaced": {
"description": "if it is true, operator will behave as a namespace-scoped operator, if it is false, it will behave as a cluster-scoped operator.",
"type": "boolean"
},
"nodeSelector": {
"description": "node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"description": "pod annotations",
"type": "object"
},
"podSecurityContext": {
"description": "security context for pod",
"type": "object"
},
"rbac": {
"properties": {
"create": {
"description": "required roles and rolebindings will be created",
"type": "boolean"
},
"name": {
"description": "name of roles and rolebindings",
"type": "string"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"enabled": {
"description": "enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"reconcilePeriod": {
"description": "reconcile duration of operator",
"type": "string"
},
"replicas": {
"description": "number of replicas",
"type": "integer"
},
"resources": {
"description": "kubernetes resources of pod",
"type": "object"
},
"securityContext": {
"description": "security context for container",
"type": "object"
},
"service": {
"properties": {
"annotations": {
"description": "service annotations",
"type": "object"
},
"enabled": {
"description": "service enabled",
"type": "boolean"
},
"externalTrafficPolicy": {
"description": "external traffic policy (can be specified when service type is LoadBalancer or NodePort) : Cluster or Local",
"type": "string"
},
"labels": {
"description": "service labels",
"type": "object"
},
"type": {
"description": "service type: ClusterIP, LoadBalancer or NodePort",
"enum": [
"ClusterIP",
"LoadBalancer",
"NodePort"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"description": "service account will be created",
"type": "boolean"
},
"name": {
"description": "name of service account",
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"description": "tolerations",
"items": {
"type": "object"
},
"type": "array"
},
"watchNamespaces": {
"description": "comma separated names of namespaces to watch, if it is empty, the namespace that the operator exists in is used.",
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | f30f6bde3d93d6149130c9302e28a07615b4c623 | 2024-02-21T06:08:54 | charts/vald-benchmark-operator/schemas/job-values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"client_config": {
"description": "gRPC client config for request to the Vald cluster",
"properties": {
"addrs": {
"description": "gRPC client addresses",
"items": {
"type": "string"
},
"type": "array"
},
"backoff": {
"properties": {
"backoff_factor": {
"description": "gRPC client backoff factor",
"type": "number"
},
"backoff_time_limit": {
"description": "gRPC client backoff time limit",
"type": "string"
},
"enable_error_log": {
"description": "gRPC client backoff log enabled",
"type": "boolean"
},
"initial_duration": {
"description": "gRPC client backoff initial duration",
"type": "string"
},
"jitter_limit": {
"description": "gRPC client backoff jitter limit",
"type": "string"
},
"maximum_duration": {
"description": "gRPC client backoff maximum duration",
"type": "string"
},
"retry_count": {
"description": "gRPC client backoff retry count",
"type": "integer"
}
},
"type": "object"
},
"call_option": {
"type": "object"
},
"circuit_breaker": {
"properties": {
"closed_error_rate": {
"description": "gRPC client circuitbreaker closed error rate",
"type": "number"
},
"closed_refresh_timeout": {
"description": "gRPC client circuitbreaker closed refresh timeout",
"type": "string"
},
"half_open_error_rate": {
"description": "gRPC client circuitbreaker half-open error rate",
"type": "number"
},
"min_samples": {
"description": "gRPC client circuitbreaker minimum sampling count",
"type": "integer"
},
"open_timeout": {
"description": "gRPC client circuitbreaker open timeout",
"type": "string"
}
},
"type": "object"
},
"connection_pool": {
"properties": {
"enable_dns_resolver": {
"description": "enables gRPC client connection pool dns resolver, when enabled vald uses ip handshake exclude dns discovery which improves network performance",
"type": "boolean"
},
"enable_rebalance": {
"description": "enables gRPC client connection pool rebalance",
"type": "boolean"
},
"old_conn_close_duration": {
"description": "makes delay before gRPC client connection closing during connection pool rebalance",
"type": "string"
},
"rebalance_duration": {
"description": "gRPC client connection pool rebalance duration",
"type": "string"
},
"size": {
"description": "gRPC client connection pool size",
"type": "integer"
}
},
"type": "object"
},
"dial_option": {
"properties": {
"backoff_base_delay": {
"description": "gRPC client dial option base backoff delay",
"type": "string"
},
"backoff_jitter": {
"description": "gRPC client dial option base backoff delay",
"type": "number"
},
"backoff_max_delay": {
"description": "gRPC client dial option max backoff delay",
"type": "string"
},
"backoff_multiplier": {
"description": "gRPC client dial option base backoff delay",
"type": "number"
},
"enable_backoff": {
"description": "gRPC client dial option backoff enabled",
"type": "boolean"
},
"initial_connection_window_size": {
"description": "gRPC client dial option initial connection window size",
"type": "integer"
},
"initial_window_size": {
"description": "gRPC client dial option initial window size",
"type": "integer"
},
"insecure": {
"description": "gRPC client dial option insecure enabled",
"type": "boolean"
},
"interceptors": {
"description": "gRPC client interceptors",
"items": {
"enum": [
"TraceInterceptor"
],
"type": "string"
},
"type": "array"
},
"keepalive": {
"properties": {
"permit_without_stream": {
"description": "gRPC client keep alive permit without stream",
"type": "boolean"
},
"time": {
"description": "gRPC client keep alive time",
"type": "string"
},
"timeout": {
"description": "gRPC client keep alive timeout",
"type": "string"
}
},
"type": "object"
},
"max_msg_size": {
"description": "gRPC client dial option max message size",
"type": "integer"
},
"min_connection_timeout": {
"description": "gRPC client dial option minimum connection timeout",
"type": "string"
},
"net": {
"properties": {
"dialer": {
"properties": {
"dual_stack_enabled": {
"description": "gRPC client TCP dialer dual stack enabled",
"type": "boolean"
},
"keepalive": {
"description": "gRPC client TCP dialer keep alive",
"type": "string"
},
"timeout": {
"description": "gRPC client TCP dialer timeout",
"type": "string"
}
},
"type": "object"
},
"dns": {
"properties": {
"cache_enabled": {
"description": "gRPC client TCP DNS cache enabled",
"type": "boolean"
},
"cache_expiration": {
"description": "gRPC client TCP DNS cache expiration",
"type": "string"
},
"refresh_duration": {
"description": "gRPC client TCP DNS cache refresh duration",
"type": "string"
}
},
"type": "object"
},
"socket_option": {
"properties": {
"ip_recover_destination_addr": {
"description": "server listen socket option for ip_recover_destination_addr functionality",
"type": "boolean"
},
"ip_transparent": {
"description": "server listen socket option for ip_transparent functionality",
"type": "boolean"
},
"reuse_addr": {
"description": "server listen socket option for reuse_addr functionality",
"type": "boolean"
},
"reuse_port": {
"description": "server listen socket option for reuse_port functionality",
"type": "boolean"
},
"tcp_cork": {
"description": "server listen socket option for tcp_cork functionality",
"type": "boolean"
},
"tcp_defer_accept": {
"description": "server listen socket option for tcp_defer_accept functionality",
"type": "boolean"
},
"tcp_fast_open": {
"description": "server listen socket option for tcp_fast_open functionality",
"type": "boolean"
},
"tcp_no_delay": {
"description": "server listen socket option for tcp_no_delay functionality",
"type": "boolean"
},
"tcp_quick_ack": {
"description": "server listen socket option for tcp_quick_ack functionality",
"type": "boolean"
}
},
"type": "object"
},
"tls": {
"properties": {
"ca": {
"type": "string"
},
"cert": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"insecure_skip_verify": {
"type": "boolean"
},
"key": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"read_buffer_size": {
"description": "gRPC client dial option read buffer size",
"type": "integer"
},
"timeout": {
"description": "gRPC client dial option timeout",
"type": "string"
},
"write_buffer_size": {
"description": "gRPC client dial option write buffer size",
"type": "integer"
}
},
"type": "object"
},
"health_check_duration": {
"description": "gRPC client health check duration",
"type": "string"
},
"max_recv_msg_size": {
"type": "integer"
},
"max_retry_rpc_buffer_size": {
"type": "integer"
},
"max_send_msg_size": {
"type": "integer"
},
"tls": {
"properties": {
"ca": {
"description": "TLS ca path",
"type": "string"
},
"cert": {
"description": "TLS cert path",
"type": "string"
},
"enabled": {
"description": "TLS enabled",
"type": "boolean"
},
"insecure_skip_verify": {
"description": "enable/disable skip SSL certificate verification",
"type": "boolean"
},
"key": {
"description": "TLS key path",
"type": "string"
}
},
"type": "object"
},
"wait_for_ready": {
"type": "boolean"
}
},
"type": "object"
},
"concurrency_limit": {
"description": "concurrency_limit represents the goroutine limit count. It affects the job performance.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"dataset": {
"description": "dataset information",
"properties": {
"group": {
"description": "the hdf5 group name of dataset",
"minLength": 1,
"type": "string"
},
"indexes": {
"description": "the amount of indexes",
"minimum": 0,
"type": "integer"
},
"name": {
"description": "the name of dataset",
"enum": [
"original",
"fashion-mnist"
],
"type": "string"
},
"range": {
"description": "the data range of indexes",
"properties": {
"end": {
"description": "end index number",
"minimum": 1,
"type": "integer"
},
"start": {
"description": "start index number",
"minimum": 1,
"type": "integer"
}
},
"required": [
"start",
"end"
],
"type": "object"
},
"url": {
"description": "the dataset url which is used for executing benchmark job with user defined hdf5 file",
"type": "string"
}
},
"required": [
"name",
"indexes",
"group",
"range"
],
"type": "object"
},
"global_config": {
"properties": {
"logging": {
"properties": {
"format": {
"enum": [
"raw",
"json"
],
"type": "string"
},
"level": {
"enum": [
"debug",
"info",
"warn",
"error",
"fatal"
],
"type": "string"
},
"logger": {
"enum": [
"glg",
"zap"
],
"type": "string"
}
},
"type": "object"
},
"time_zone": {
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"insert_config": {
"description": "insert config",
"properties": {
"skip_strict_exist_check": {
"description": "skip strict exists check flag config",
"type": "boolean"
},
"timestamp": {
"description": "index timestamp",
"type": "string"
}
},
"type": "object"
},
"job_type": {
"description": "job type name",
"enum": [
"insert",
"update",
"upsert",
"search",
"remove",
"getobject",
"exists"
],
"type": "string"
},
"object_config": {
"description": "object config",
"properties": {
"filter_config": {
"description": "filter target config",
"properties": {
"host": {
"description": "filter target host",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"remove_config": {
"description": "remove config",
"properties": {
"skip_strict_exist_check": {
"description": "skip strict exists check flag config",
"type": "boolean"
},
"timestamp": {
"description": "index timestamp",
"type": "string"
}
},
"type": "object"
},
"repetition": {
"description": "the number of repeat job",
"minimum": 1,
"type": "integer"
},
"replica": {
"description": "the number of running concurrency job",
"minimum": 1,
"type": "integer"
},
"rps": {
"description": "desired request per sec",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"rules": {
"description": "executing rule",
"items": {
"type": "string"
},
"type": "array"
},
"search_config": {
"description": "upsert config",
"properties": {
"aggregation_algorithm": {
"description": "search result aggregation algorithm",
"enum": [
"Unknown",
"ConcurrentQueue",
"SortSlice",
"SortPoolSlice",
"PairingHeap"
],
"type": "string"
},
"enable_linear_search": {
"description": "enable linear search for calculation recall",
"type": "boolean"
},
"epsilon": {
"description": "epsilon",
"type": "number"
},
"min_num": {
"description": "minimum number of top-k",
"type": "integer"
},
"num": {
"description": "number of top-k",
"type": "integer"
},
"radius": {
"description": "radius",
"type": "number"
},
"timeout": {
"description": "search operation timeout",
"type": "string"
}
},
"type": "object"
},
"server_config": {
"properties": {
"healths": {
"properties": {
"liveness": {
"properties": {
"enabled": {
"description": "liveness server enabled",
"type": "boolean"
},
"host": {
"description": "liveness server host",
"type": "string"
},
"livenessProbe": {
"properties": {
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "liveness probe path",
"type": "string"
},
"port": {
"description": "liveness probe port",
"type": "string"
},
"scheme": {
"description": "liveness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"port": {
"description": "liveness server port",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"server": {
"properties": {
"http": {
"properties": {
"handler_timeout": {
"description": "liveness server handler timeout",
"type": "string"
},
"idle_timeout": {
"description": "liveness server idle timeout",
"type": "string"
},
"read_header_timeout": {
"description": "liveness server read header timeout",
"type": "string"
},
"read_timeout": {
"description": "liveness server read timeout",
"type": "string"
},
"shutdown_duration": {
"description": "liveness server shutdown duration",
"type": "string"
},
"write_timeout": {
"description": "liveness server write timeout",
"type": "string"
}
},
"type": "object"
},
"mode": {
"description": "liveness server mode",
"type": "string"
},
"network": {
"description": "mysql network",
"enum": [
"tcp",
"tcp4",
"tcp6",
"udp",
"udp4",
"udp6",
"unix",
"unixgram",
"unixpacket"
],
"type": "string"
},
"probe_wait_time": {
"description": "liveness server probe wait time",
"type": "string"
},
"socket_option": {
"properties": {
"ip_recover_destination_addr": {
"description": "server listen socket option for ip_recover_destination_addr functionality",
"type": "boolean"
},
"ip_transparent": {
"description": "server listen socket option for ip_transparent functionality",
"type": "boolean"
},
"reuse_addr": {
"description": "server listen socket option for reuse_addr functionality",
"type": "boolean"
},
"reuse_port": {
"description": "server listen socket option for reuse_port functionality",
"type": "boolean"
},
"tcp_cork": {
"description": "server listen socket option for tcp_cork functionality",
"type": "boolean"
},
"tcp_defer_accept": {
"description": "server listen socket option for tcp_defer_accept functionality",
"type": "boolean"
},
"tcp_fast_open": {
"description": "server listen socket option for tcp_fast_open functionality",
"type": "boolean"
},
"tcp_no_delay": {
"description": "server listen socket option for tcp_no_delay functionality",
"type": "boolean"
},
"tcp_quick_ack": {
"description": "server listen socket option for tcp_quick_ack functionality",
"type": "boolean"
}
},
"type": "object"
},
"socket_path": {
"description": "mysql socket_path",
"type": "string"
}
},
"type": "object"
},
"servicePort": {
"description": "liveness server service port",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"readiness": {
"properties": {
"enabled": {
"description": "readiness server enabled",
"type": "boolean"
},
"host": {
"description": "readiness server host",
"type": "string"
},
"port": {
"description": "readiness server port",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"readinessProbe": {
"properties": {
"failureThreshold": {
"description": "readiness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "readiness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "readiness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "readiness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "readiness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"server": {
"properties": {
"http": {
"properties": {
"handler_timeout": {
"description": "readiness server handler timeout",
"type": "string"
},
"idle_timeout": {
"description": "readiness server idle timeout",
"type": "string"
},
"read_header_timeout": {
"description": "readiness server read header timeout",
"type": "string"
},
"read_timeout": {
"description": "readiness server read timeout",
"type": "string"
},
"shutdown_duration": {
"description": "readiness server shutdown duration",
"type": "string"
},
"write_timeout": {
"description": "readiness server write timeout",
"type": "string"
}
},
"type": "object"
},
"mode": {
"description": "readiness server mode",
"type": "string"
},
"network": {
"description": "mysql network",
"enum": [
"tcp",
"tcp4",
"tcp6",
"udp",
"udp4",
"udp6",
"unix",
"unixgram",
"unixpacket"
],
"type": "string"
},
"probe_wait_time": {
"description": "readiness server probe wait time",
"type": "string"
},
"socket_option": {
"properties": {
"ip_recover_destination_addr": {
"description": "server listen socket option for ip_recover_destination_addr functionality",
"type": "boolean"
},
"ip_transparent": {
"description": "server listen socket option for ip_transparent functionality",
"type": "boolean"
},
"reuse_addr": {
"description": "server listen socket option for reuse_addr functionality",
"type": "boolean"
},
"reuse_port": {
"description": "server listen socket option for reuse_port functionality",
"type": "boolean"
},
"tcp_cork": {
"description": "server listen socket option for tcp_cork functionality",
"type": "boolean"
},
"tcp_defer_accept": {
"description": "server listen socket option for tcp_defer_accept functionality",
"type": "boolean"
},
"tcp_fast_open": {
"description": "server listen socket option for tcp_fast_open functionality",
"type": "boolean"
},
"tcp_no_delay": {
"description": "server listen socket option for tcp_no_delay functionality",
"type": "boolean"
},
"tcp_quick_ack": {
"description": "server listen socket option for tcp_quick_ack functionality",
"type": "boolean"
}
},
"type": "object"
},
"socket_path": {
"description": "mysql socket_path",
"type": "string"
}
},
"type": "object"
},
"servicePort": {
"description": "readiness server service port",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"startup": {
"properties": {
"enabled": {
"description": "startup server enabled",
"type": "boolean"
},
"port": {
"description": "startup server port",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"startupProbe": {
"properties": {
"failureThreshold": {
"description": "startup probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "startup probe path",
"type": "string"
},
"port": {
"description": "startup probe port",
"type": "string"
},
"scheme": {
"description": "startup probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "startup probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "startup probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "startup probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "startup probe timeout seconds",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"servers": {
"properties": {
"grpc": {
"properties": {
"enabled": {
"description": "gRPC server enabled",
"type": "boolean"
},
"host": {
"description": "gRPC server host",
"type": "string"
},
"port": {
"description": "gRPC server port",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"server": {
"properties": {
"grpc": {
"properties": {
"bidirectional_stream_concurrency": {
"description": "gRPC server bidirectional stream concurrency",
"type": "integer"
},
"connection_timeout": {
"description": "gRPC server connection timeout",
"type": "string"
},
"enable_reflection": {
"description": "gRPC server reflection option",
"type": "boolean"
},
"header_table_size": {
"description": "gRPC server header table size",
"type": "integer"
},
"initial_conn_window_size": {
"description": "gRPC server initial connection window size",
"type": "integer"
},
"initial_window_size": {
"description": "gRPC server initial window size",
"type": "integer"
},
"interceptors": {
"description": "gRPC server interceptors",
"items": {
"enum": [
"RecoverInterceptor",
"AccessLogInterceptor",
"TraceInterceptor",
"MetricInterceptor"
],
"type": "string"
},
"type": "array"
},
"keepalive": {
"properties": {
"max_conn_age": {
"description": "gRPC server keep alive max connection age",
"type": "string"
},
"max_conn_age_grace": {
"description": "gRPC server keep alive max connection age grace",
"type": "string"
},
"max_conn_idle": {
"description": "gRPC server keep alive max connection idle",
"type": "string"
},
"min_time": {
"description": "gRPC server keep alive min_time",
"type": "string"
},
"permit_without_stream": {
"description": "gRPC server keep alive permit_without_stream",
"type": "boolean"
},
"time": {
"description": "gRPC server keep alive time",
"type": "string"
},
"timeout": {
"description": "gRPC server keep alive timeout",
"type": "string"
}
},
"type": "object"
},
"max_header_list_size": {
"description": "gRPC server max header list size",
"type": "integer"
},
"max_receive_message_size": {
"description": "gRPC server max receive message size",
"type": "integer"
},
"max_send_message_size": {
"description": "gRPC server max send message size",
"type": "integer"
},
"read_buffer_size": {
"description": "gRPC server read buffer size",
"type": "integer"
},
"write_buffer_size": {
"description": "gRPC server write buffer size",
"type": "integer"
}
},
"type": "object"
},
"mode": {
"description": "gRPC server server mode",
"type": "string"
},
"network": {
"description": "mysql network",
"enum": [
"tcp",
"tcp4",
"tcp6",
"udp",
"udp4",
"udp6",
"unix",
"unixgram",
"unixpacket"
],
"type": "string"
},
"probe_wait_time": {
"description": "gRPC server probe wait time",
"type": "string"
},
"restart": {
"description": "gRPC server restart",
"type": "boolean"
},
"socket_option": {
"properties": {
"ip_recover_destination_addr": {
"description": "server listen socket option for ip_recover_destination_addr functionality",
"type": "boolean"
},
"ip_transparent": {
"description": "server listen socket option for ip_transparent functionality",
"type": "boolean"
},
"reuse_addr": {
"description": "server listen socket option for reuse_addr functionality",
"type": "boolean"
},
"reuse_port": {
"description": "server listen socket option for reuse_port functionality",
"type": "boolean"
},
"tcp_cork": {
"description": "server listen socket option for tcp_cork functionality",
"type": "boolean"
},
"tcp_defer_accept": {
"description": "server listen socket option for tcp_defer_accept functionality",
"type": "boolean"
},
"tcp_fast_open": {
"description": "server listen socket option for tcp_fast_open functionality",
"type": "boolean"
},
"tcp_no_delay": {
"description": "server listen socket option for tcp_no_delay functionality",
"type": "boolean"
},
"tcp_quick_ack": {
"description": "server listen socket option for tcp_quick_ack functionality",
"type": "boolean"
}
},
"type": "object"
},
"socket_path": {
"description": "mysql socket_path",
"type": "string"
}
},
"type": "object"
},
"servicePort": {
"description": "gRPC server service port",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"rest": {
"properties": {
"enabled": {
"description": "REST server enabled",
"type": "boolean"
},
"host": {
"description": "REST server host",
"type": "string"
},
"port": {
"description": "REST server port",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"server": {
"properties": {
"http": {
"properties": {
"handler_timeout": {
"description": "REST server handler timeout",
"type": "string"
},
"idle_timeout": {
"description": "REST server idle timeout",
"type": "string"
},
"read_header_timeout": {
"description": "REST server read header timeout",
"type": "string"
},
"read_timeout": {
"description": "REST server read timeout",
"type": "string"
},
"shutdown_duration": {
"description": "REST server shutdown duration",
"type": "string"
},
"write_timeout": {
"description": "REST server write timeout",
"type": "string"
}
},
"type": "object"
},
"mode": {
"description": "REST server server mode",
"type": "string"
},
"network": {
"description": "mysql network",
"enum": [
"tcp",
"tcp4",
"tcp6",
"udp",
"udp4",
"udp6",
"unix",
"unixgram",
"unixpacket"
],
"type": "string"
},
"probe_wait_time": {
"description": "REST server probe wait time",
"type": "string"
},
"socket_option": {
"properties": {
"ip_recover_destination_addr": {
"description": "server listen socket option for ip_recover_destination_addr functionality",
"type": "boolean"
},
"ip_transparent": {
"description": "server listen socket option for ip_transparent functionality",
"type": "boolean"
},
"reuse_addr": {
"description": "server listen socket option for reuse_addr functionality",
"type": "boolean"
},
"reuse_port": {
"description": "server listen socket option for reuse_port functionality",
"type": "boolean"
},
"tcp_cork": {
"description": "server listen socket option for tcp_cork functionality",
"type": "boolean"
},
"tcp_defer_accept": {
"description": "server listen socket option for tcp_defer_accept functionality",
"type": "boolean"
},
"tcp_fast_open": {
"description": "server listen socket option for tcp_fast_open functionality",
"type": "boolean"
},
"tcp_no_delay": {
"description": "server listen socket option for tcp_no_delay functionality",
"type": "boolean"
},
"tcp_quick_ack": {
"description": "server listen socket option for tcp_quick_ack functionality",
"type": "boolean"
}
},
"type": "object"
},
"socket_path": {
"description": "mysql socket_path",
"type": "string"
}
},
"type": "object"
},
"servicePort": {
"description": "REST server service port",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"target": {
"description": "target cluster location",
"properties": {
"host": {
"description": "target cluster host",
"minLength": 1,
"type": "string"
},
"port": {
"description": "target cluster port",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"required": [
"host",
"port"
],
"type": "object"
},
"ttl_seconds_after_finished": {
"description": "limits the lifetime of a Job that has finished execution.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"update_config": {
"description": "update config",
"properties": {
"disable_balance_update": {
"description": "disabled balance update flag",
"type": "boolean"
},
"skip_strict_exist_check": {
"description": "skip strict exists check flag config",
"type": "boolean"
},
"timestamp": {
"description": "index timestamp",
"type": "string"
}
},
"type": "object"
},
"upsert_config": {
"description": "upsert config",
"properties": {
"disable_balance_update": {
"description": "disabled balance update flag",
"type": "boolean"
},
"skip_strict_exist_check": {
"description": "skip strict exists check flag config",
"type": "boolean"
},
"timestamp": {
"description": "index timestamp",
"type": "string"
}
},
"type": "object"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | a85cad4b53c02b67b43f90466f486d95e22da594 | 2023-03-03T06:49:29 | charts/vald-helm-operator/values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"affinity": {
"description": "affinity",
"type": "object"
},
"annotations": {
"description": "deployment annotations",
"type": "object"
},
"enableLeaderElection": {
"description": "enable leader election for controller manager.",
"type": "boolean"
},
"enableMetrics": {
"description": "enable metrics endpoint",
"type": "boolean"
},
"healthPort": {
"description": "port of health endpoint",
"type": "integer"
},
"image": {
"properties": {
"pullPolicy": {
"description": "image pull policy",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"description": "image repository",
"type": "string"
},
"tag": {
"description": "image tag",
"type": "string"
}
},
"type": "object"
},
"leaderElectionID": {
"description": "name of the configmap that is used for holding the leader lock.",
"type": "string"
},
"livenessProbe": {
"properties": {
"enabled": {
"description": "enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"logging": {
"properties": {
"format": {
"description": "logging format of operator (console or json)",
"enum": [
"console",
"json"
],
"type": "string"
},
"level": {
"description": "logging level of operator (debug, info, or error)",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
},
"stacktraceLevel": {
"description": "minimum log level triggers stacktrace generation",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
}
},
"type": "object"
},
"maxConcurrentReconciles": {
"description": "max number of concurrent reconciles",
"type": "integer"
},
"metricsPort": {
"description": "port of metrics endpoint",
"type": "integer"
},
"name": {
"description": "name of the deployment",
"type": "string"
},
"namespaced": {
"description": "if it is true, operator will behave as a namespace-scoped operator, if it is false, it will behave as a cluster-scoped operator.",
"type": "boolean"
},
"nodeSelector": {
"description": "node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"description": "pod annotations",
"type": "object"
},
"podSecurityContext": {
"description": "security context for pod",
"type": "object"
},
"rbac": {
"properties": {
"create": {
"description": "required roles and rolebindings will be created",
"type": "boolean"
},
"name": {
"description": "name of roles and rolebindings",
"type": "string"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"enabled": {
"description": "enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"reconcilePeriod": {
"description": "reconcile duration of operator",
"type": "string"
},
"replicas": {
"description": "number of replicas",
"type": "integer"
},
"resources": {
"description": "kubernetes resources of pod",
"type": "object"
},
"securityContext": {
"description": "security context for container",
"type": "object"
},
"service": {
"properties": {
"annotations": {
"description": "service annotations",
"type": "object"
},
"enabled": {
"description": "service enabled",
"type": "boolean"
},
"externalTrafficPolicy": {
"description": "external traffic policy (can be specified when service type is LoadBalancer or NodePort) : Cluster or Local",
"type": "string"
},
"labels": {
"description": "service labels",
"type": "object"
},
"type": {
"description": "service type: ClusterIP, LoadBalancer or NodePort",
"enum": [
"ClusterIP",
"LoadBalancer",
"NodePort"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"description": "service account will be created",
"type": "boolean"
},
"name": {
"description": "name of service account",
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"description": "tolerations",
"items": {
"type": "object"
},
"type": "array"
},
"watchNamespaces": {
"description": "comma separated names of namespaces to watch, if it is empty, the namespace that the operator exists in is used.",
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | 9a08508c040d2bc8cfac47375ce63dc9ad3c3e51 | 2023-09-14T07:44:28 | charts/vald-helm-operator/values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"affinity": {
"description": "affinity",
"type": "object"
},
"annotations": {
"description": "deployment annotations",
"type": "object"
},
"enableLeaderElection": {
"description": "enable leader election for controller manager.",
"type": "boolean"
},
"enableMetrics": {
"description": "enable metrics endpoint",
"type": "boolean"
},
"healthPort": {
"description": "port of health endpoint",
"type": "integer"
},
"image": {
"properties": {
"pullPolicy": {
"description": "image pull policy",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"description": "image repository",
"type": "string"
},
"tag": {
"description": "image tag",
"type": "string"
}
},
"type": "object"
},
"leaderElectionID": {
"description": "name of the configmap that is used for holding the leader lock.",
"type": "string"
},
"livenessProbe": {
"properties": {
"enabled": {
"description": "enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"logging": {
"properties": {
"format": {
"description": "logging format of operator (console or json)",
"enum": [
"console",
"json"
],
"type": "string"
},
"level": {
"description": "logging level of operator (debug, info, or error)",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
},
"stacktraceLevel": {
"description": "minimum log level triggers stacktrace generation",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
}
},
"type": "object"
},
"maxConcurrentReconciles": {
"description": "max number of concurrent reconciles",
"type": "integer"
},
"metricsPort": {
"description": "port of metrics endpoint",
"type": "integer"
},
"name": {
"description": "name of the deployment",
"type": "string"
},
"namespaced": {
"description": "if it is true, operator will behave as a namespace-scoped operator, if it is false, it will behave as a cluster-scoped operator.",
"type": "boolean"
},
"nodeSelector": {
"description": "node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"description": "pod annotations",
"type": "object"
},
"podSecurityContext": {
"description": "security context for pod",
"type": "object"
},
"rbac": {
"properties": {
"create": {
"description": "required roles and rolebindings will be created",
"type": "boolean"
},
"name": {
"description": "name of roles and rolebindings",
"type": "string"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"enabled": {
"description": "enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"reconcilePeriod": {
"description": "reconcile duration of operator",
"type": "string"
},
"replicas": {
"description": "number of replicas",
"type": "integer"
},
"resources": {
"description": "kubernetes resources of pod",
"type": "object"
},
"securityContext": {
"description": "security context for container",
"type": "object"
},
"service": {
"properties": {
"annotations": {
"description": "service annotations",
"type": "object"
},
"enabled": {
"description": "service enabled",
"type": "boolean"
},
"externalTrafficPolicy": {
"description": "external traffic policy (can be specified when service type is LoadBalancer or NodePort) : Cluster or Local",
"type": "string"
},
"labels": {
"description": "service labels",
"type": "object"
},
"type": {
"description": "service type: ClusterIP, LoadBalancer or NodePort",
"enum": [
"ClusterIP",
"LoadBalancer",
"NodePort"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"description": "service account will be created",
"type": "boolean"
},
"name": {
"description": "name of service account",
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"description": "tolerations",
"items": {
"type": "object"
},
"type": "array"
},
"watchNamespaces": {
"description": "comma separated names of namespaces to watch, if it is empty, the namespace that the operator exists in is used.",
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | b8417b0ca0239dbfd448e64647de1418c944e419 | 2023-03-13T03:49:59 | charts/vald-helm-operator/values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"affinity": {
"description": "affinity",
"type": "object"
},
"annotations": {
"description": "deployment annotations",
"type": "object"
},
"enableLeaderElection": {
"description": "enable leader election for controller manager.",
"type": "boolean"
},
"enableMetrics": {
"description": "enable metrics endpoint",
"type": "boolean"
},
"healthPort": {
"description": "port of health endpoint",
"type": "integer"
},
"image": {
"properties": {
"pullPolicy": {
"description": "image pull policy",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"description": "image repository",
"type": "string"
},
"tag": {
"description": "image tag",
"type": "string"
}
},
"type": "object"
},
"leaderElectionID": {
"description": "name of the configmap that is used for holding the leader lock.",
"type": "string"
},
"livenessProbe": {
"properties": {
"enabled": {
"description": "enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"logging": {
"properties": {
"format": {
"description": "logging format of operator (console or json)",
"enum": [
"console",
"json"
],
"type": "string"
},
"level": {
"description": "logging level of operator (debug, info, or error)",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
},
"stacktraceLevel": {
"description": "minimum log level triggers stacktrace generation",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
}
},
"type": "object"
},
"maxConcurrentReconciles": {
"description": "max number of concurrent reconciles",
"type": "integer"
},
"metricsPort": {
"description": "port of metrics endpoint",
"type": "integer"
},
"name": {
"description": "name of the deployment",
"type": "string"
},
"namespaced": {
"description": "if it is true, operator will behave as a namespace-scoped operator, if it is false, it will behave as a cluster-scoped operator.",
"type": "boolean"
},
"nodeSelector": {
"description": "node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"description": "pod annotations",
"type": "object"
},
"podSecurityContext": {
"description": "security context for pod",
"type": "object"
},
"rbac": {
"properties": {
"create": {
"description": "required roles and rolebindings will be created",
"type": "boolean"
},
"name": {
"description": "name of roles and rolebindings",
"type": "string"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"enabled": {
"description": "enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"reconcilePeriod": {
"description": "reconcile duration of operator",
"type": "string"
},
"replicas": {
"description": "number of replicas",
"type": "integer"
},
"resources": {
"description": "kubernetes resources of pod",
"type": "object"
},
"securityContext": {
"description": "security context for container",
"type": "object"
},
"service": {
"properties": {
"annotations": {
"description": "service annotations",
"type": "object"
},
"enabled": {
"description": "service enabled",
"type": "boolean"
},
"externalTrafficPolicy": {
"description": "external traffic policy (can be specified when service type is LoadBalancer or NodePort) : Cluster or Local",
"type": "string"
},
"labels": {
"description": "service labels",
"type": "object"
},
"type": {
"description": "service type: ClusterIP, LoadBalancer or NodePort",
"enum": [
"ClusterIP",
"LoadBalancer",
"NodePort"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"description": "service account will be created",
"type": "boolean"
},
"name": {
"description": "name of service account",
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"description": "tolerations",
"items": {
"type": "object"
},
"type": "array"
},
"watchNamespaces": {
"description": "comma separated names of namespaces to watch, if it is empty, the namespace that the operator exists in is used.",
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | 814480c6fb01cc269d93063d7a0fc9b975b0c0f0 | 2020-05-27T05:01:42 | charts/vald-helm-operator/values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"affinity": {
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"type": "object"
},
"logging": {
"properties": {
"format": {
"enum": [
"console",
"json"
],
"type": "string"
},
"level": {
"enum": [
"debug",
"info",
"error"
],
"type": "string"
},
"stacktraceLevel": {
"enum": [
"debug",
"info",
"error"
],
"type": "string"
},
"timeEncoding": {
"enum": [
"epoch",
"millis",
"nano",
"iso8601"
],
"type": "string"
}
},
"type": "object"
},
"maxWorkers": {
"type": "integer"
},
"name": {
"type": "string"
},
"nodeSelector": {
"type": "object"
},
"rbac": {
"properties": {
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"reconcilePeriod": {
"type": "string"
},
"replicas": {
"type": "integer"
},
"resources": {
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"items": {
"type": "object"
},
"type": "array"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | 754fa7dbdf4786c889d2ae44c12efb8d6110d712 | 2022-04-18T03:20:19 | charts/vald-helm-operator/values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"affinity": {
"description": "affinity",
"type": "object"
},
"annotations": {
"description": "deployment annotations",
"type": "object"
},
"enableLeaderElection": {
"description": "enable leader election for controller manager.",
"type": "boolean"
},
"enableMetrics": {
"description": "enable metrics endpoint",
"type": "boolean"
},
"healthPort": {
"description": "port of health endpoint",
"type": "integer"
},
"image": {
"properties": {
"pullPolicy": {
"description": "image pull policy",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"description": "image repository",
"type": "string"
},
"tag": {
"description": "image tag",
"type": "string"
}
},
"type": "object"
},
"leaderElectionID": {
"description": "name of the configmap that is used for holding the leader lock.",
"type": "string"
},
"livenessProbe": {
"properties": {
"enabled": {
"description": "enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"logging": {
"properties": {
"format": {
"description": "logging format of operator (console or json)",
"enum": [
"console",
"json"
],
"type": "string"
},
"level": {
"description": "logging level of operator (debug, info, or error)",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
},
"stacktraceLevel": {
"description": "minimum log level triggers stacktrace generation",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
}
},
"type": "object"
},
"maxConcurrentReconciles": {
"description": "max number of concurrent reconciles",
"type": "integer"
},
"metricsPort": {
"description": "port of metrics endpoint",
"type": "integer"
},
"name": {
"description": "name of the deployment",
"type": "string"
},
"namespaced": {
"description": "if it is true, operator will behave as a namespace-scoped operator, if it is false, it will behave as a cluster-scoped operator.",
"type": "boolean"
},
"nodeSelector": {
"description": "node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"description": "pod annotations",
"type": "object"
},
"podSecurityContext": {
"description": "security context for pod",
"type": "object"
},
"rbac": {
"properties": {
"create": {
"description": "required roles and rolebindings will be created",
"type": "boolean"
},
"name": {
"description": "name of roles and rolebindings",
"type": "string"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"enabled": {
"description": "enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"reconcilePeriod": {
"description": "reconcile duration of operator",
"type": "string"
},
"replicas": {
"description": "number of replicas",
"type": "integer"
},
"resources": {
"description": "kubernetes resources of pod",
"type": "object"
},
"securityContext": {
"description": "security context for container",
"type": "object"
},
"service": {
"properties": {
"annotations": {
"description": "service annotations",
"type": "object"
},
"enabled": {
"description": "service enabled",
"type": "boolean"
},
"externalTrafficPolicy": {
"description": "external traffic policy (can be specified when service type is LoadBalancer or NodePort) : Cluster or Local",
"type": "string"
},
"labels": {
"description": "service labels",
"type": "object"
},
"type": {
"description": "service type: ClusterIP, LoadBalancer or NodePort",
"enum": [
"ClusterIP",
"LoadBalancer",
"NodePort"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"description": "service account will be created",
"type": "boolean"
},
"name": {
"description": "name of service account",
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"description": "tolerations",
"items": {
"type": "object"
},
"type": "array"
},
"watchNamespaces": {
"description": "comma separated names of namespaces to watch, if it is empty, the namespace that the operator exists in is used.",
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | 979074566d2c055db97854d31ed5bc51d0ffd8ce | 2023-03-13T05:06:51 | charts/vald-helm-operator/values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"affinity": {
"description": "affinity",
"type": "object"
},
"annotations": {
"description": "deployment annotations",
"type": "object"
},
"enableLeaderElection": {
"description": "enable leader election for controller manager.",
"type": "boolean"
},
"enableMetrics": {
"description": "enable metrics endpoint",
"type": "boolean"
},
"healthPort": {
"description": "port of health endpoint",
"type": "integer"
},
"image": {
"properties": {
"pullPolicy": {
"description": "image pull policy",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"description": "image repository",
"type": "string"
},
"tag": {
"description": "image tag",
"type": "string"
}
},
"type": "object"
},
"leaderElectionID": {
"description": "name of the configmap that is used for holding the leader lock.",
"type": "string"
},
"livenessProbe": {
"properties": {
"enabled": {
"description": "enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"logging": {
"properties": {
"format": {
"description": "logging format of operator (console or json)",
"enum": [
"console",
"json"
],
"type": "string"
},
"level": {
"description": "logging level of operator (debug, info, or error)",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
},
"stacktraceLevel": {
"description": "minimum log level triggers stacktrace generation",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
}
},
"type": "object"
},
"maxConcurrentReconciles": {
"description": "max number of concurrent reconciles",
"type": "integer"
},
"metricsPort": {
"description": "port of metrics endpoint",
"type": "integer"
},
"name": {
"description": "name of the deployment",
"type": "string"
},
"namespaced": {
"description": "if it is true, operator will behave as a namespace-scoped operator, if it is false, it will behave as a cluster-scoped operator.",
"type": "boolean"
},
"nodeSelector": {
"description": "node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"description": "pod annotations",
"type": "object"
},
"podSecurityContext": {
"description": "security context for pod",
"type": "object"
},
"rbac": {
"properties": {
"create": {
"description": "required roles and rolebindings will be created",
"type": "boolean"
},
"name": {
"description": "name of roles and rolebindings",
"type": "string"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"enabled": {
"description": "enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"reconcilePeriod": {
"description": "reconcile duration of operator",
"type": "string"
},
"replicas": {
"description": "number of replicas",
"type": "integer"
},
"resources": {
"description": "kubernetes resources of pod",
"type": "object"
},
"securityContext": {
"description": "security context for container",
"type": "object"
},
"service": {
"properties": {
"annotations": {
"description": "service annotations",
"type": "object"
},
"enabled": {
"description": "service enabled",
"type": "boolean"
},
"externalTrafficPolicy": {
"description": "external traffic policy (can be specified when service type is LoadBalancer or NodePort) : Cluster or Local",
"type": "string"
},
"labels": {
"description": "service labels",
"type": "object"
},
"type": {
"description": "service type: ClusterIP, LoadBalancer or NodePort",
"enum": [
"ClusterIP",
"LoadBalancer",
"NodePort"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"description": "service account will be created",
"type": "boolean"
},
"name": {
"description": "name of service account",
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"description": "tolerations",
"items": {
"type": "object"
},
"type": "array"
},
"watchNamespaces": {
"description": "comma separated names of namespaces to watch, if it is empty, the namespace that the operator exists in is used.",
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | c2e3cc123892434fb552ba7fc73db9a56df0dea8 | 2023-03-03T09:06:31 | charts/vald-helm-operator/values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"affinity": {
"description": "affinity",
"type": "object"
},
"annotations": {
"description": "deployment annotations",
"type": "object"
},
"enableLeaderElection": {
"description": "enable leader election for controller manager.",
"type": "boolean"
},
"enableMetrics": {
"description": "enable metrics endpoint",
"type": "boolean"
},
"healthPort": {
"description": "port of health endpoint",
"type": "integer"
},
"image": {
"properties": {
"pullPolicy": {
"description": "image pull policy",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"description": "image repository",
"type": "string"
},
"tag": {
"description": "image tag",
"type": "string"
}
},
"type": "object"
},
"leaderElectionID": {
"description": "name of the configmap that is used for holding the leader lock.",
"type": "string"
},
"livenessProbe": {
"properties": {
"enabled": {
"description": "enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"logging": {
"properties": {
"format": {
"description": "logging format of operator (console or json)",
"enum": [
"console",
"json"
],
"type": "string"
},
"level": {
"description": "logging level of operator (debug, info, or error)",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
},
"stacktraceLevel": {
"description": "minimum log level triggers stacktrace generation",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
}
},
"type": "object"
},
"maxConcurrentReconciles": {
"description": "max number of concurrent reconciles",
"type": "integer"
},
"metricsPort": {
"description": "port of metrics endpoint",
"type": "integer"
},
"name": {
"description": "name of the deployment",
"type": "string"
},
"namespaced": {
"description": "if it is true, operator will behave as a namespace-scoped operator, if it is false, it will behave as a cluster-scoped operator.",
"type": "boolean"
},
"nodeSelector": {
"description": "node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"description": "pod annotations",
"type": "object"
},
"podSecurityContext": {
"description": "security context for pod",
"type": "object"
},
"rbac": {
"properties": {
"create": {
"description": "required roles and rolebindings will be created",
"type": "boolean"
},
"name": {
"description": "name of roles and rolebindings",
"type": "string"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"enabled": {
"description": "enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"reconcilePeriod": {
"description": "reconcile duration of operator",
"type": "string"
},
"replicas": {
"description": "number of replicas",
"type": "integer"
},
"resources": {
"description": "kubernetes resources of pod",
"type": "object"
},
"securityContext": {
"description": "security context for container",
"type": "object"
},
"service": {
"properties": {
"annotations": {
"description": "service annotations",
"type": "object"
},
"enabled": {
"description": "service enabled",
"type": "boolean"
},
"externalTrafficPolicy": {
"description": "external traffic policy (can be specified when service type is LoadBalancer or NodePort) : Cluster or Local",
"type": "string"
},
"labels": {
"description": "service labels",
"type": "object"
},
"type": {
"description": "service type: ClusterIP, LoadBalancer or NodePort",
"enum": [
"ClusterIP",
"LoadBalancer",
"NodePort"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"description": "service account will be created",
"type": "boolean"
},
"name": {
"description": "name of service account",
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"description": "tolerations",
"items": {
"type": "object"
},
"type": "array"
},
"watchNamespaces": {
"description": "comma separated names of namespaces to watch, if it is empty, the namespace that the operator exists in is used.",
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | f5186e95fa53310f83972bc12185de713e632218 | 2024-03-15T08:13:18 | charts/vald-benchmark-operator/values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"affinity": {
"description": "affinity",
"type": "object"
},
"annotations": {
"description": "deployment annotations",
"type": "object"
},
"env": {
"description": "environment variables",
"items": {
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"description": "image pull policy",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"description": "job image repository",
"type": "string"
},
"tag": {
"description": "image tag for job docker image",
"type": "string"
}
},
"type": "object"
},
"job_image": {
"properties": {
"pullPolicy": {
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"type": "object"
},
"logging": {
"properties": {
"format": {
"description": "logging format. logging format must be `raw` or `json`",
"enum": [
"raw",
"json"
],
"type": "string"
},
"level": {
"description": "logging level. logging level must be `debug`, `info`, `warn`, `error` or `fatal`.",
"enum": [
"debug",
"info",
"warn",
"error",
"fatal"
],
"type": "string"
},
"logger": {
"description": "logger name. currently logger must be `glg` or `zap`.",
"enum": [
"glg",
"zap"
],
"type": "string"
}
},
"type": "object"
},
"name": {
"description": "name of the deployment",
"type": "string"
},
"nodeSelector": {
"description": "node labels for pod assignment",
"type": "object"
},
"observability": {
"properties": {
"enabled": {
"type": "boolean"
},
"otlp": {
"properties": {
"attribute": {
"properties": {
"metrics": {
"properties": {
"enable_cgo": {
"type": "boolean"
},
"enable_goroutine": {
"type": "boolean"
},
"enable_memory": {
"type": "boolean"
},
"enable_version_info": {
"type": "boolean"
},
"version_info_labels": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"namespace": {
"type": "string"
},
"node_name": {
"type": "string"
},
"pod_name": {
"type": "string"
},
"service_name": {
"type": "string"
}
},
"type": "object"
},
"collector_endpoint": {
"type": "string"
},
"metrics_export_interval": {
"type": "string"
},
"metrics_export_timeout": {
"type": "string"
},
"trace_batch_timeout": {
"type": "string"
},
"trace_export_timeout": {
"type": "string"
},
"trace_max_export_batch_size": {
"type": "integer"
},
"trace_max_queue_size": {
"type": "integer"
}
},
"type": "object"
},
"trace": {
"properties": {
"enabled": {
"type": "boolean"
},
"sampling_rate": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"podAnnotations": {
"description": "pod annotations",
"type": "object"
},
"podSecurityContext": {
"description": "security context for pod",
"type": "object"
},
"rbac": {
"properties": {
"create": {
"description": "required roles and rolebindings will be created",
"type": "boolean"
},
"name": {
"description": "name of roles and rolebindings",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "the number of replica for deployment",
"type": "integer"
},
"resources": {
"description": "kubernetes resources of pod",
"properties": {
"limits": {
"type": "object"
},
"requests": {
"type": "object"
}
},
"type": "object"
},
"securityContext": {
"description": "security context for container",
"type": "object"
},
"server_config": {
"properties": {
"full_shutdown_duration": {
"type": "string"
},
"healths": {
"properties": {
"liveness": {
"properties": {
"enabled": {
"type": "boolean"
},
"host": {
"type": "string"
},
"livenessProbe": {
"properties": {
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"port": {
"type": "integer"
},
"server": {
"properties": {
"http": {
"properties": {
"idle_timeout": {
"type": "string"
},
"read_header_timeout": {
"type": "string"
},
"read_timeout": {
"type": "string"
},
"shutdown_duration": {
"type": "string"
},
"timeout": {
"type": "string"
},
"write_timeout": {
"type": "string"
}
},
"type": "object"
},
"mode": {
"type": "string"
},
"network": {
"type": "string"
},
"probe_wait_time": {
"type": "string"
},
"socket_path": {
"type": "string"
}
},
"type": "object"
},
"servicePort": {
"type": "integer"
}
},
"type": "object"
},
"readiness": {
"properties": {
"enabled": {
"type": "boolean"
},
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"readinessProbe": {
"properties": {
"failureThreshold": {
"description": "readiness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "readiness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "readiness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "readiness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "readiness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"server": {
"properties": {
"http": {
"properties": {
"handler_timeout": {
"type": "string"
},
"idle_timeout": {
"type": "string"
},
"read_header_timeout": {
"type": "string"
},
"read_timeout": {
"type": "string"
},
"shutdown_duration": {
"type": "string"
},
"write_timeout": {
"type": "string"
}
},
"type": "object"
},
"mode": {
"type": "string"
},
"network": {
"type": "string"
},
"probe_wait_time": {
"type": "string"
},
"socket_path": {
"type": "string"
}
},
"type": "object"
},
"servicePort": {
"type": "integer"
}
},
"type": "object"
},
"startup": {
"properties": {
"enabled": {
"description": "enable startup probe.",
"type": "boolean"
}
},
"type": "object"
},
"startupProbe": {
"properties": {
"failureThreshold": {
"description": "startupProbe probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "startup probe path",
"type": "string"
},
"port": {
"description": "startup probe port",
"type": "string"
},
"scheme": {
"description": "startup probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "startup probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "startup probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "startup probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "startup probe timeout seconds",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"metrics": {
"properties": {
"pprof": {
"properties": {
"enabled": {
"type": "boolean"
},
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"server": {
"properties": {
"http": {
"properties": {
"handler_timeout": {
"type": "string"
},
"idle_timeout": {
"type": "string"
},
"read_header_timeout": {
"type": "string"
},
"read_timeout": {
"type": "string"
},
"shutdown_duration": {
"type": "string"
},
"write_timeout": {
"type": "string"
}
},
"type": "object"
},
"mode": {
"type": "string"
},
"network": {
"type": "string"
},
"probe_wait_time": {
"type": "string"
},
"socket_path": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"servers": {
"properties": {
"grpc": {
"properties": {
"enabled": {
"type": "boolean"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"port": {
"type": "integer"
},
"server": {
"properties": {
"grpc": {
"properties": {
"bidirectional_stream_concurrency": {
"type": "integer"
},
"connection_timeout": {
"type": "string"
},
"enable_reflection": {
"type": "boolean"
},
"header_table_size": {
"type": "integer"
},
"initial_conn_window_size": {
"type": "integer"
},
"initial_window_size": {
"type": "integer"
},
"interceptors": {
"items": {
"type": "string"
},
"type": "array"
},
"keepalive": {
"properties": {
"max_conn_age": {
"description": "gRPC server keep alive max connection age",
"type": "string"
},
"max_conn_age_grace": {
"description": "gRPC server keep alive max connection age grace",
"type": "string"
},
"max_conn_idle": {
"description": "gRPC server keep alive max connection idle",
"type": "string"
},
"min_time": {
"description": "gRPC server keep alive min_time",
"type": "string"
},
"permit_without_stream": {
"description": "gRPC server keep alive permit_without_stream",
"type": "boolean"
},
"time": {
"description": "gRPC server keep alive time",
"type": "string"
},
"timeout": {
"description": "gRPC server keep alive timeout",
"type": "string"
}
},
"type": "object"
},
"max_header_list_size": {
"type": "integer"
},
"max_receive_message_size": {
"type": "integer"
},
"max_send_msg_size": {
"type": "integer"
},
"read_buffer_size": {
"type": "integer"
},
"write_buffer_size": {
"type": "integer"
}
},
"type": "object"
},
"mode": {
"type": "string"
},
"network": {
"type": "string"
},
"probe_wait_time": {
"type": "string"
},
"restart": {
"type": "boolean"
},
"socket_path": {
"type": "string"
}
},
"type": "object"
},
"servicePort": {
"type": "integer"
}
},
"type": "object"
},
"rest": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"tls": {
"properties": {
"ca": {
"type": "string"
},
"cert": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"insecure_skip_verify": {
"description": "enable/disable skip SSL certificate verification",
"type": "boolean"
},
"key": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"annotations": {
"description": "service annotations",
"type": "object"
},
"enabled": {
"description": "service enabled",
"type": "boolean"
},
"externalTrafficPolicy": {
"description": "external traffic policy (can be specified when service type is LoadBalancer or NodePort) : Cluster or Local",
"type": "string"
},
"labels": {
"description": "service labels",
"type": "object"
},
"type": {
"description": "service type: ClusterIP, LoadBalancer or NodePort",
"enum": [
"ClusterIP",
"LoadBalancer",
"NodePort"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"description": "service account will be created",
"type": "boolean"
},
"name": {
"description": "name of service account",
"type": "string"
}
},
"type": "object"
},
"time_zone": {
"description": "time_zone",
"type": "string"
},
"tolerations": {
"description": "tolerations",
"items": {
"type": "object"
},
"type": "array"
},
"version": {
"description": "version of benchmark-operator config",
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | 1c01cb47519a4cf1771596a01b434455a7fe7566 | 2023-03-29T08:50:44 | charts/vald-helm-operator/values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"affinity": {
"description": "affinity",
"type": "object"
},
"annotations": {
"description": "deployment annotations",
"type": "object"
},
"enableLeaderElection": {
"description": "enable leader election for controller manager.",
"type": "boolean"
},
"enableMetrics": {
"description": "enable metrics endpoint",
"type": "boolean"
},
"healthPort": {
"description": "port of health endpoint",
"type": "integer"
},
"image": {
"properties": {
"pullPolicy": {
"description": "image pull policy",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"description": "image repository",
"type": "string"
},
"tag": {
"description": "image tag",
"type": "string"
}
},
"type": "object"
},
"leaderElectionID": {
"description": "name of the configmap that is used for holding the leader lock.",
"type": "string"
},
"livenessProbe": {
"properties": {
"enabled": {
"description": "enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"logging": {
"properties": {
"format": {
"description": "logging format of operator (console or json)",
"enum": [
"console",
"json"
],
"type": "string"
},
"level": {
"description": "logging level of operator (debug, info, or error)",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
},
"stacktraceLevel": {
"description": "minimum log level triggers stacktrace generation",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
}
},
"type": "object"
},
"maxConcurrentReconciles": {
"description": "max number of concurrent reconciles",
"type": "integer"
},
"metricsPort": {
"description": "port of metrics endpoint",
"type": "integer"
},
"name": {
"description": "name of the deployment",
"type": "string"
},
"namespaced": {
"description": "if it is true, operator will behave as a namespace-scoped operator, if it is false, it will behave as a cluster-scoped operator.",
"type": "boolean"
},
"nodeSelector": {
"description": "node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"description": "pod annotations",
"type": "object"
},
"podSecurityContext": {
"description": "security context for pod",
"type": "object"
},
"rbac": {
"properties": {
"create": {
"description": "required roles and rolebindings will be created",
"type": "boolean"
},
"name": {
"description": "name of roles and rolebindings",
"type": "string"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"enabled": {
"description": "enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"reconcilePeriod": {
"description": "reconcile duration of operator",
"type": "string"
},
"replicas": {
"description": "number of replicas",
"type": "integer"
},
"resources": {
"description": "kubernetes resources of pod",
"type": "object"
},
"securityContext": {
"description": "security context for container",
"type": "object"
},
"service": {
"properties": {
"annotations": {
"description": "service annotations",
"type": "object"
},
"enabled": {
"description": "service enabled",
"type": "boolean"
},
"externalTrafficPolicy": {
"description": "external traffic policy (can be specified when service type is LoadBalancer or NodePort) : Cluster or Local",
"type": "string"
},
"labels": {
"description": "service labels",
"type": "object"
},
"type": {
"description": "service type: ClusterIP, LoadBalancer or NodePort",
"enum": [
"ClusterIP",
"LoadBalancer",
"NodePort"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"description": "service account will be created",
"type": "boolean"
},
"name": {
"description": "name of service account",
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"description": "tolerations",
"items": {
"type": "object"
},
"type": "array"
},
"watchNamespaces": {
"description": "comma separated names of namespaces to watch, if it is empty, the namespace that the operator exists in is used.",
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | 5a9c8efaa91ccc370427bd5f7def40b56dfb1ef8 | 2023-06-29T08:52:23 | charts/vald-helm-operator/values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"affinity": {
"description": "affinity",
"type": "object"
},
"annotations": {
"description": "deployment annotations",
"type": "object"
},
"enableLeaderElection": {
"description": "enable leader election for controller manager.",
"type": "boolean"
},
"enableMetrics": {
"description": "enable metrics endpoint",
"type": "boolean"
},
"healthPort": {
"description": "port of health endpoint",
"type": "integer"
},
"image": {
"properties": {
"pullPolicy": {
"description": "image pull policy",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"description": "image repository",
"type": "string"
},
"tag": {
"description": "image tag",
"type": "string"
}
},
"type": "object"
},
"leaderElectionID": {
"description": "name of the configmap that is used for holding the leader lock.",
"type": "string"
},
"livenessProbe": {
"properties": {
"enabled": {
"description": "enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"logging": {
"properties": {
"format": {
"description": "logging format of operator (console or json)",
"enum": [
"console",
"json"
],
"type": "string"
},
"level": {
"description": "logging level of operator (debug, info, or error)",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
},
"stacktraceLevel": {
"description": "minimum log level triggers stacktrace generation",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
}
},
"type": "object"
},
"maxConcurrentReconciles": {
"description": "max number of concurrent reconciles",
"type": "integer"
},
"metricsPort": {
"description": "port of metrics endpoint",
"type": "integer"
},
"name": {
"description": "name of the deployment",
"type": "string"
},
"namespaced": {
"description": "if it is true, operator will behave as a namespace-scoped operator, if it is false, it will behave as a cluster-scoped operator.",
"type": "boolean"
},
"nodeSelector": {
"description": "node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"description": "pod annotations",
"type": "object"
},
"podSecurityContext": {
"description": "security context for pod",
"type": "object"
},
"rbac": {
"properties": {
"create": {
"description": "required roles and rolebindings will be created",
"type": "boolean"
},
"name": {
"description": "name of roles and rolebindings",
"type": "string"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"enabled": {
"description": "enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"reconcilePeriod": {
"description": "reconcile duration of operator",
"type": "string"
},
"replicas": {
"description": "number of replicas",
"type": "integer"
},
"resources": {
"description": "kubernetes resources of pod",
"type": "object"
},
"securityContext": {
"description": "security context for container",
"type": "object"
},
"service": {
"properties": {
"annotations": {
"description": "service annotations",
"type": "object"
},
"enabled": {
"description": "service enabled",
"type": "boolean"
},
"externalTrafficPolicy": {
"description": "external traffic policy (can be specified when service type is LoadBalancer or NodePort) : Cluster or Local",
"type": "string"
},
"labels": {
"description": "service labels",
"type": "object"
},
"type": {
"description": "service type: ClusterIP, LoadBalancer or NodePort",
"enum": [
"ClusterIP",
"LoadBalancer",
"NodePort"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"description": "service account will be created",
"type": "boolean"
},
"name": {
"description": "name of service account",
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"description": "tolerations",
"items": {
"type": "object"
},
"type": "array"
},
"watchNamespaces": {
"description": "comma separated names of namespaces to watch, if it is empty, the namespace that the operator exists in is used.",
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | 0865888d884c99ae334dc089cfb0aaa6056dbbb9 | 2021-02-26T04:19:38 | charts/vald-helm-operator/values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"affinity": {
"type": "object"
},
"annotations": {
"type": "object"
},
"enableLeaderElection": {
"type": "boolean"
},
"enableMetrics": {
"type": "boolean"
},
"healthPort": {
"type": "integer"
},
"image": {
"properties": {
"pullPolicy": {
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"type": "object"
},
"leaderElectionID": {
"type": "string"
},
"livenessProbe": {
"properties": {
"enabled": {
"type": "boolean"
},
"failureThreshold": {
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
},
"scheme": {
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"logging": {
"properties": {
"format": {
"enum": [
"console",
"json"
],
"type": "string"
},
"level": {
"enum": [
"debug",
"info",
"error"
],
"type": "string"
},
"stacktraceLevel": {
"enum": [
"debug",
"info",
"error"
],
"type": "string"
}
},
"type": "object"
},
"maxConcurrentReconciles": {
"type": "integer"
},
"metricsPort": {
"type": "integer"
},
"name": {
"type": "string"
},
"namespaced": {
"type": "boolean"
},
"nodeSelector": {
"type": "object"
},
"podAnnotations": {
"type": "object"
},
"rbac": {
"properties": {
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"enabled": {
"type": "boolean"
},
"failureThreshold": {
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
},
"scheme": {
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"reconcilePeriod": {
"type": "string"
},
"replicas": {
"type": "integer"
},
"resources": {
"type": "object"
},
"service": {
"properties": {
"annotations": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"externalTrafficPolicy": {
"type": "string"
},
"labels": {
"type": "object"
},
"type": {
"enum": [
"ClusterIP",
"LoadBalancer",
"NodePort"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"items": {
"type": "object"
},
"type": "array"
},
"watchNamespaces": {
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | 085ee5355d2ebd2422f31731531a14b9cab78dc1 | 2023-01-24T04:14:24 | charts/vald-helm-operator/values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"affinity": {
"description": "affinity",
"type": "object"
},
"annotations": {
"description": "deployment annotations",
"type": "object"
},
"enableLeaderElection": {
"description": "enable leader election for controller manager.",
"type": "boolean"
},
"enableMetrics": {
"description": "enable metrics endpoint",
"type": "boolean"
},
"healthPort": {
"description": "port of health endpoint",
"type": "integer"
},
"image": {
"properties": {
"pullPolicy": {
"description": "image pull policy",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"description": "image repository",
"type": "string"
},
"tag": {
"description": "image tag",
"type": "string"
}
},
"type": "object"
},
"leaderElectionID": {
"description": "name of the configmap that is used for holding the leader lock.",
"type": "string"
},
"livenessProbe": {
"properties": {
"enabled": {
"description": "enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"logging": {
"properties": {
"format": {
"description": "logging format of operator (console or json)",
"enum": [
"console",
"json"
],
"type": "string"
},
"level": {
"description": "logging level of operator (debug, info, or error)",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
},
"stacktraceLevel": {
"description": "minimum log level triggers stacktrace generation",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
}
},
"type": "object"
},
"maxConcurrentReconciles": {
"description": "max number of concurrent reconciles",
"type": "integer"
},
"metricsPort": {
"description": "port of metrics endpoint",
"type": "integer"
},
"name": {
"description": "name of the deployment",
"type": "string"
},
"namespaced": {
"description": "if it is true, operator will behave as a namespace-scoped operator, if it is false, it will behave as a cluster-scoped operator.",
"type": "boolean"
},
"nodeSelector": {
"description": "node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"description": "pod annotations",
"type": "object"
},
"podSecurityContext": {
"description": "security context for pod",
"type": "object"
},
"rbac": {
"properties": {
"create": {
"description": "required roles and rolebindings will be created",
"type": "boolean"
},
"name": {
"description": "name of roles and rolebindings",
"type": "string"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"enabled": {
"description": "enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"reconcilePeriod": {
"description": "reconcile duration of operator",
"type": "string"
},
"replicas": {
"description": "number of replicas",
"type": "integer"
},
"resources": {
"description": "kubernetes resources of pod",
"type": "object"
},
"securityContext": {
"description": "security context for container",
"type": "object"
},
"service": {
"properties": {
"annotations": {
"description": "service annotations",
"type": "object"
},
"enabled": {
"description": "service enabled",
"type": "boolean"
},
"externalTrafficPolicy": {
"description": "external traffic policy (can be specified when service type is LoadBalancer or NodePort) : Cluster or Local",
"type": "string"
},
"labels": {
"description": "service labels",
"type": "object"
},
"type": {
"description": "service type: ClusterIP, LoadBalancer or NodePort",
"enum": [
"ClusterIP",
"LoadBalancer",
"NodePort"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"description": "service account will be created",
"type": "boolean"
},
"name": {
"description": "name of service account",
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"description": "tolerations",
"items": {
"type": "object"
},
"type": "array"
},
"watchNamespaces": {
"description": "comma separated names of namespaces to watch, if it is empty, the namespace that the operator exists in is used.",
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | b776f11f307e763dcf9c2e23fe78f1c19d65c949 | 2023-02-09T05:42:34 | charts/vald-helm-operator/values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"affinity": {
"description": "affinity",
"type": "object"
},
"annotations": {
"description": "deployment annotations",
"type": "object"
},
"enableLeaderElection": {
"description": "enable leader election for controller manager.",
"type": "boolean"
},
"enableMetrics": {
"description": "enable metrics endpoint",
"type": "boolean"
},
"healthPort": {
"description": "port of health endpoint",
"type": "integer"
},
"image": {
"properties": {
"pullPolicy": {
"description": "image pull policy",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"description": "image repository",
"type": "string"
},
"tag": {
"description": "image tag",
"type": "string"
}
},
"type": "object"
},
"leaderElectionID": {
"description": "name of the configmap that is used for holding the leader lock.",
"type": "string"
},
"livenessProbe": {
"properties": {
"enabled": {
"description": "enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"logging": {
"properties": {
"format": {
"description": "logging format of operator (console or json)",
"enum": [
"console",
"json"
],
"type": "string"
},
"level": {
"description": "logging level of operator (debug, info, or error)",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
},
"stacktraceLevel": {
"description": "minimum log level triggers stacktrace generation",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
}
},
"type": "object"
},
"maxConcurrentReconciles": {
"description": "max number of concurrent reconciles",
"type": "integer"
},
"metricsPort": {
"description": "port of metrics endpoint",
"type": "integer"
},
"name": {
"description": "name of the deployment",
"type": "string"
},
"namespaced": {
"description": "if it is true, operator will behave as a namespace-scoped operator, if it is false, it will behave as a cluster-scoped operator.",
"type": "boolean"
},
"nodeSelector": {
"description": "node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"description": "pod annotations",
"type": "object"
},
"podSecurityContext": {
"description": "security context for pod",
"type": "object"
},
"rbac": {
"properties": {
"create": {
"description": "required roles and rolebindings will be created",
"type": "boolean"
},
"name": {
"description": "name of roles and rolebindings",
"type": "string"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"enabled": {
"description": "enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"reconcilePeriod": {
"description": "reconcile duration of operator",
"type": "string"
},
"replicas": {
"description": "number of replicas",
"type": "integer"
},
"resources": {
"description": "kubernetes resources of pod",
"type": "object"
},
"securityContext": {
"description": "security context for container",
"type": "object"
},
"service": {
"properties": {
"annotations": {
"description": "service annotations",
"type": "object"
},
"enabled": {
"description": "service enabled",
"type": "boolean"
},
"externalTrafficPolicy": {
"description": "external traffic policy (can be specified when service type is LoadBalancer or NodePort) : Cluster or Local",
"type": "string"
},
"labels": {
"description": "service labels",
"type": "object"
},
"type": {
"description": "service type: ClusterIP, LoadBalancer or NodePort",
"enum": [
"ClusterIP",
"LoadBalancer",
"NodePort"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"description": "service account will be created",
"type": "boolean"
},
"name": {
"description": "name of service account",
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"description": "tolerations",
"items": {
"type": "object"
},
"type": "array"
},
"watchNamespaces": {
"description": "comma separated names of namespaces to watch, if it is empty, the namespace that the operator exists in is used.",
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | afa9d230b8eb1b5f8411ed8c39af5b02ee09583a | 2023-06-12T13:33:58 | charts/vald-helm-operator/values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"affinity": {
"description": "affinity",
"type": "object"
},
"annotations": {
"description": "deployment annotations",
"type": "object"
},
"enableLeaderElection": {
"description": "enable leader election for controller manager.",
"type": "boolean"
},
"enableMetrics": {
"description": "enable metrics endpoint",
"type": "boolean"
},
"healthPort": {
"description": "port of health endpoint",
"type": "integer"
},
"image": {
"properties": {
"pullPolicy": {
"description": "image pull policy",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"description": "image repository",
"type": "string"
},
"tag": {
"description": "image tag",
"type": "string"
}
},
"type": "object"
},
"leaderElectionID": {
"description": "name of the configmap that is used for holding the leader lock.",
"type": "string"
},
"livenessProbe": {
"properties": {
"enabled": {
"description": "enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"logging": {
"properties": {
"format": {
"description": "logging format of operator (console or json)",
"enum": [
"console",
"json"
],
"type": "string"
},
"level": {
"description": "logging level of operator (debug, info, or error)",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
},
"stacktraceLevel": {
"description": "minimum log level triggers stacktrace generation",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
}
},
"type": "object"
},
"maxConcurrentReconciles": {
"description": "max number of concurrent reconciles",
"type": "integer"
},
"metricsPort": {
"description": "port of metrics endpoint",
"type": "integer"
},
"name": {
"description": "name of the deployment",
"type": "string"
},
"namespaced": {
"description": "if it is true, operator will behave as a namespace-scoped operator, if it is false, it will behave as a cluster-scoped operator.",
"type": "boolean"
},
"nodeSelector": {
"description": "node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"description": "pod annotations",
"type": "object"
},
"podSecurityContext": {
"description": "security context for pod",
"type": "object"
},
"rbac": {
"properties": {
"create": {
"description": "required roles and rolebindings will be created",
"type": "boolean"
},
"name": {
"description": "name of roles and rolebindings",
"type": "string"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"enabled": {
"description": "enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"reconcilePeriod": {
"description": "reconcile duration of operator",
"type": "string"
},
"replicas": {
"description": "number of replicas",
"type": "integer"
},
"resources": {
"description": "kubernetes resources of pod",
"type": "object"
},
"securityContext": {
"description": "security context for container",
"type": "object"
},
"service": {
"properties": {
"annotations": {
"description": "service annotations",
"type": "object"
},
"enabled": {
"description": "service enabled",
"type": "boolean"
},
"externalTrafficPolicy": {
"description": "external traffic policy (can be specified when service type is LoadBalancer or NodePort) : Cluster or Local",
"type": "string"
},
"labels": {
"description": "service labels",
"type": "object"
},
"type": {
"description": "service type: ClusterIP, LoadBalancer or NodePort",
"enum": [
"ClusterIP",
"LoadBalancer",
"NodePort"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"description": "service account will be created",
"type": "boolean"
},
"name": {
"description": "name of service account",
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"description": "tolerations",
"items": {
"type": "object"
},
"type": "array"
},
"watchNamespaces": {
"description": "comma separated names of namespaces to watch, if it is empty, the namespace that the operator exists in is used.",
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | 1d8e7bc4638952469b76712414c25d10d0ad33c2 | 2023-04-25T02:42:28 | charts/vald-helm-operator/values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"affinity": {
"description": "affinity",
"type": "object"
},
"annotations": {
"description": "deployment annotations",
"type": "object"
},
"enableLeaderElection": {
"description": "enable leader election for controller manager.",
"type": "boolean"
},
"enableMetrics": {
"description": "enable metrics endpoint",
"type": "boolean"
},
"healthPort": {
"description": "port of health endpoint",
"type": "integer"
},
"image": {
"properties": {
"pullPolicy": {
"description": "image pull policy",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"description": "image repository",
"type": "string"
},
"tag": {
"description": "image tag",
"type": "string"
}
},
"type": "object"
},
"leaderElectionID": {
"description": "name of the configmap that is used for holding the leader lock.",
"type": "string"
},
"livenessProbe": {
"properties": {
"enabled": {
"description": "enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"logging": {
"properties": {
"format": {
"description": "logging format of operator (console or json)",
"enum": [
"console",
"json"
],
"type": "string"
},
"level": {
"description": "logging level of operator (debug, info, or error)",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
},
"stacktraceLevel": {
"description": "minimum log level triggers stacktrace generation",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
}
},
"type": "object"
},
"maxConcurrentReconciles": {
"description": "max number of concurrent reconciles",
"type": "integer"
},
"metricsPort": {
"description": "port of metrics endpoint",
"type": "integer"
},
"name": {
"description": "name of the deployment",
"type": "string"
},
"namespaced": {
"description": "if it is true, operator will behave as a namespace-scoped operator, if it is false, it will behave as a cluster-scoped operator.",
"type": "boolean"
},
"nodeSelector": {
"description": "node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"description": "pod annotations",
"type": "object"
},
"podSecurityContext": {
"description": "security context for pod",
"type": "object"
},
"rbac": {
"properties": {
"create": {
"description": "required roles and rolebindings will be created",
"type": "boolean"
},
"name": {
"description": "name of roles and rolebindings",
"type": "string"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"enabled": {
"description": "enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"reconcilePeriod": {
"description": "reconcile duration of operator",
"type": "string"
},
"replicas": {
"description": "number of replicas",
"type": "integer"
},
"resources": {
"description": "kubernetes resources of pod",
"type": "object"
},
"securityContext": {
"description": "security context for container",
"type": "object"
},
"service": {
"properties": {
"annotations": {
"description": "service annotations",
"type": "object"
},
"enabled": {
"description": "service enabled",
"type": "boolean"
},
"externalTrafficPolicy": {
"description": "external traffic policy (can be specified when service type is LoadBalancer or NodePort) : Cluster or Local",
"type": "string"
},
"labels": {
"description": "service labels",
"type": "object"
},
"type": {
"description": "service type: ClusterIP, LoadBalancer or NodePort",
"enum": [
"ClusterIP",
"LoadBalancer",
"NodePort"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"description": "service account will be created",
"type": "boolean"
},
"name": {
"description": "name of service account",
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"description": "tolerations",
"items": {
"type": "object"
},
"type": "array"
},
"watchNamespaces": {
"description": "comma separated names of namespaces to watch, if it is empty, the namespace that the operator exists in is used.",
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | 2d22f0ef684d24e70b540c4e9d9e529f4e4efcc6 | 2022-12-16T23:36:10 | charts/vald-helm-operator/values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"affinity": {
"description": "affinity",
"type": "object"
},
"annotations": {
"description": "deployment annotations",
"type": "object"
},
"enableLeaderElection": {
"description": "enable leader election for controller manager.",
"type": "boolean"
},
"enableMetrics": {
"description": "enable metrics endpoint",
"type": "boolean"
},
"healthPort": {
"description": "port of health endpoint",
"type": "integer"
},
"image": {
"properties": {
"pullPolicy": {
"description": "image pull policy",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"description": "image repository",
"type": "string"
},
"tag": {
"description": "image tag",
"type": "string"
}
},
"type": "object"
},
"leaderElectionID": {
"description": "name of the configmap that is used for holding the leader lock.",
"type": "string"
},
"livenessProbe": {
"properties": {
"enabled": {
"description": "enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"logging": {
"properties": {
"format": {
"description": "logging format of operator (console or json)",
"enum": [
"console",
"json"
],
"type": "string"
},
"level": {
"description": "logging level of operator (debug, info, or error)",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
},
"stacktraceLevel": {
"description": "minimum log level triggers stacktrace generation",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
}
},
"type": "object"
},
"maxConcurrentReconciles": {
"description": "max number of concurrent reconciles",
"type": "integer"
},
"metricsPort": {
"description": "port of metrics endpoint",
"type": "integer"
},
"name": {
"description": "name of the deployment",
"type": "string"
},
"namespaced": {
"description": "if it is true, operator will behave as a namespace-scoped operator, if it is false, it will behave as a cluster-scoped operator.",
"type": "boolean"
},
"nodeSelector": {
"description": "node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"description": "pod annotations",
"type": "object"
},
"podSecurityContext": {
"description": "security context for pod",
"type": "object"
},
"rbac": {
"properties": {
"create": {
"description": "required roles and rolebindings will be created",
"type": "boolean"
},
"name": {
"description": "name of roles and rolebindings",
"type": "string"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"enabled": {
"description": "enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"reconcilePeriod": {
"description": "reconcile duration of operator",
"type": "string"
},
"replicas": {
"description": "number of replicas",
"type": "integer"
},
"resources": {
"description": "kubernetes resources of pod",
"type": "object"
},
"securityContext": {
"description": "security context for container",
"type": "object"
},
"service": {
"properties": {
"annotations": {
"description": "service annotations",
"type": "object"
},
"enabled": {
"description": "service enabled",
"type": "boolean"
},
"externalTrafficPolicy": {
"description": "external traffic policy (can be specified when service type is LoadBalancer or NodePort) : Cluster or Local",
"type": "string"
},
"labels": {
"description": "service labels",
"type": "object"
},
"type": {
"description": "service type: ClusterIP, LoadBalancer or NodePort",
"enum": [
"ClusterIP",
"LoadBalancer",
"NodePort"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"description": "service account will be created",
"type": "boolean"
},
"name": {
"description": "name of service account",
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"description": "tolerations",
"items": {
"type": "object"
},
"type": "array"
},
"watchNamespaces": {
"description": "comma separated names of namespaces to watch, if it is empty, the namespace that the operator exists in is used.",
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | c964badf76413c8307abf1614859c2b1c92ff1bb | 2023-09-15T01:21:44 | charts/vald-helm-operator/values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"affinity": {
"description": "affinity",
"type": "object"
},
"annotations": {
"description": "deployment annotations",
"type": "object"
},
"enableLeaderElection": {
"description": "enable leader election for controller manager.",
"type": "boolean"
},
"enableMetrics": {
"description": "enable metrics endpoint",
"type": "boolean"
},
"healthPort": {
"description": "port of health endpoint",
"type": "integer"
},
"image": {
"properties": {
"pullPolicy": {
"description": "image pull policy",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"description": "image repository",
"type": "string"
},
"tag": {
"description": "image tag",
"type": "string"
}
},
"type": "object"
},
"leaderElectionID": {
"description": "name of the configmap that is used for holding the leader lock.",
"type": "string"
},
"livenessProbe": {
"properties": {
"enabled": {
"description": "enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"logging": {
"properties": {
"format": {
"description": "logging format of operator (console or json)",
"enum": [
"console",
"json"
],
"type": "string"
},
"level": {
"description": "logging level of operator (debug, info, or error)",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
},
"stacktraceLevel": {
"description": "minimum log level triggers stacktrace generation",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
}
},
"type": "object"
},
"maxConcurrentReconciles": {
"description": "max number of concurrent reconciles",
"type": "integer"
},
"metricsPort": {
"description": "port of metrics endpoint",
"type": "integer"
},
"name": {
"description": "name of the deployment",
"type": "string"
},
"namespaced": {
"description": "if it is true, operator will behave as a namespace-scoped operator, if it is false, it will behave as a cluster-scoped operator.",
"type": "boolean"
},
"nodeSelector": {
"description": "node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"description": "pod annotations",
"type": "object"
},
"podSecurityContext": {
"description": "security context for pod",
"type": "object"
},
"rbac": {
"properties": {
"create": {
"description": "required roles and rolebindings will be created",
"type": "boolean"
},
"name": {
"description": "name of roles and rolebindings",
"type": "string"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"enabled": {
"description": "enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"reconcilePeriod": {
"description": "reconcile duration of operator",
"type": "string"
},
"replicas": {
"description": "number of replicas",
"type": "integer"
},
"resources": {
"description": "kubernetes resources of pod",
"type": "object"
},
"securityContext": {
"description": "security context for container",
"type": "object"
},
"service": {
"properties": {
"annotations": {
"description": "service annotations",
"type": "object"
},
"enabled": {
"description": "service enabled",
"type": "boolean"
},
"externalTrafficPolicy": {
"description": "external traffic policy (can be specified when service type is LoadBalancer or NodePort) : Cluster or Local",
"type": "string"
},
"labels": {
"description": "service labels",
"type": "object"
},
"type": {
"description": "service type: ClusterIP, LoadBalancer or NodePort",
"enum": [
"ClusterIP",
"LoadBalancer",
"NodePort"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"description": "service account will be created",
"type": "boolean"
},
"name": {
"description": "name of service account",
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"description": "tolerations",
"items": {
"type": "object"
},
"type": "array"
},
"watchNamespaces": {
"description": "comma separated names of namespaces to watch, if it is empty, the namespace that the operator exists in is used.",
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | f943916ea585a1976d59c271d572c14c541ae464 | 2024-01-11T05:51:50 | charts/vald-benchmark-operator/values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"affinity": {
"description": "affinity",
"type": "object"
},
"annotations": {
"description": "deployment annotations",
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "image pull policy",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"description": "job image repository",
"type": "string"
},
"tag": {
"description": "image tag for job docker image",
"type": "string"
}
},
"type": "object"
},
"job_image": {
"properties": {
"pullPolicy": {
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"type": "object"
},
"logging": {
"properties": {
"format": {
"description": "logging format. logging format must be `raw` or `json`",
"enum": [
"raw",
"json"
],
"type": "string"
},
"level": {
"description": "logging level. logging level must be `debug`, `info`, `warn`, `error` or `fatal`.",
"enum": [
"debug",
"info",
"warn",
"error",
"fatal"
],
"type": "string"
},
"logger": {
"description": "logger name. currently logger must be `glg` or `zap`.",
"enum": [
"glg",
"zap"
],
"type": "string"
}
},
"type": "object"
},
"name": {
"description": "name of the deployment",
"type": "string"
},
"nodeSelector": {
"description": "node labels for pod assignment",
"type": "object"
},
"observability": {
"properties": {
"enabled": {
"type": "boolean"
},
"otlp": {
"properties": {
"attribute": {
"properties": {
"metrics": {
"properties": {
"enable_cgo": {
"type": "boolean"
},
"enable_goroutine": {
"type": "boolean"
},
"enable_memory": {
"type": "boolean"
},
"enable_version_info": {
"type": "boolean"
},
"version_info_labels": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"namespace": {
"type": "string"
},
"node_name": {
"type": "string"
},
"pod_name": {
"type": "string"
},
"service_name": {
"type": "string"
}
},
"type": "object"
},
"collector_endpoint": {
"type": "string"
},
"metrics_export_interval": {
"type": "string"
},
"metrics_export_timeout": {
"type": "string"
},
"trace_batch_timeout": {
"type": "string"
},
"trace_export_timeout": {
"type": "string"
},
"trace_max_export_batch_size": {
"type": "integer"
},
"trace_max_queue_size": {
"type": "integer"
}
},
"type": "object"
},
"trace": {
"properties": {
"enabled": {
"type": "boolean"
},
"sampling_rate": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"podAnnotations": {
"description": "pod annotations",
"type": "object"
},
"podSecurityContext": {
"description": "security context for pod",
"type": "object"
},
"rbac": {
"properties": {
"create": {
"description": "required roles and rolebindings will be created",
"type": "boolean"
},
"name": {
"description": "name of roles and rolebindings",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "the number of replica for deployment",
"type": "integer"
},
"resources": {
"description": "kubernetes resources of pod",
"properties": {
"limits": {
"type": "object"
},
"requests": {
"type": "object"
}
},
"type": "object"
},
"securityContext": {
"description": "security context for container",
"type": "object"
},
"server_config": {
"properties": {
"full_shutdown_duration": {
"type": "string"
},
"healths": {
"properties": {
"liveness": {
"properties": {
"enabled": {
"type": "boolean"
},
"host": {
"type": "string"
},
"livenessProbe": {
"properties": {
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"port": {
"type": "integer"
},
"server": {
"properties": {
"http": {
"properties": {
"idle_timeout": {
"type": "string"
},
"read_header_timeout": {
"type": "string"
},
"read_timeout": {
"type": "string"
},
"shutdown_duration": {
"type": "string"
},
"timeout": {
"type": "string"
},
"write_timeout": {
"type": "string"
}
},
"type": "object"
},
"mode": {
"type": "string"
},
"network": {
"type": "string"
},
"probe_wait_time": {
"type": "string"
},
"socket_path": {
"type": "string"
}
},
"type": "object"
},
"servicePort": {
"type": "integer"
}
},
"type": "object"
},
"readiness": {
"properties": {
"enabled": {
"type": "boolean"
},
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"readinessProbe": {
"properties": {
"failureThreshold": {
"description": "readiness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "readiness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "readiness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "readiness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "readiness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"server": {
"properties": {
"http": {
"properties": {
"handler_timeout": {
"type": "string"
},
"idle_timeout": {
"type": "string"
},
"read_header_timeout": {
"type": "string"
},
"read_timeout": {
"type": "string"
},
"shutdown_duration": {
"type": "string"
},
"write_timeout": {
"type": "string"
}
},
"type": "object"
},
"mode": {
"type": "string"
},
"network": {
"type": "string"
},
"probe_wait_time": {
"type": "string"
},
"socket_path": {
"type": "string"
}
},
"type": "object"
},
"servicePort": {
"type": "integer"
}
},
"type": "object"
},
"startup": {
"properties": {
"enabled": {
"description": "enable startup probe.",
"type": "boolean"
}
},
"type": "object"
},
"startupProbe": {
"properties": {
"failureThreshold": {
"description": "startupProbe probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "startup probe path",
"type": "string"
},
"port": {
"description": "startup probe port",
"type": "string"
},
"scheme": {
"description": "startup probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "startup probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "startup probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "startup probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "startup probe timeout seconds",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"metrics": {
"properties": {
"pprof": {
"properties": {
"enabled": {
"type": "boolean"
},
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"server": {
"properties": {
"http": {
"properties": {
"handler_timeout": {
"type": "string"
},
"idle_timeout": {
"type": "string"
},
"read_header_timeout": {
"type": "string"
},
"read_timeout": {
"type": "string"
},
"shutdown_duration": {
"type": "string"
},
"write_timeout": {
"type": "string"
}
},
"type": "object"
},
"mode": {
"type": "string"
},
"network": {
"type": "string"
},
"probe_wait_time": {
"type": "string"
},
"socket_path": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"servers": {
"properties": {
"grpc": {
"properties": {
"enabled": {
"type": "boolean"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"port": {
"type": "integer"
},
"server": {
"properties": {
"grpc": {
"properties": {
"bidirectional_stream_concurrency": {
"type": "integer"
},
"connection_timeout": {
"type": "string"
},
"enable_reflection": {
"type": "boolean"
},
"header_table_size": {
"type": "integer"
},
"initial_conn_window_size": {
"type": "integer"
},
"initial_window_size": {
"type": "integer"
},
"interceptors": {
"items": {
"type": "string"
},
"type": "array"
},
"keepalive": {
"properties": {
"max_conn_age": {
"description": "gRPC server keep alive max connection age",
"type": "string"
},
"max_conn_age_grace": {
"description": "gRPC server keep alive max connection age grace",
"type": "string"
},
"max_conn_idle": {
"description": "gRPC server keep alive max connection idle",
"type": "string"
},
"min_time": {
"description": "gRPC server keep alive min_time",
"type": "string"
},
"permit_without_stream": {
"description": "gRPC server keep alive permit_without_stream",
"type": "boolean"
},
"time": {
"description": "gRPC server keep alive time",
"type": "string"
},
"timeout": {
"description": "gRPC server keep alive timeout",
"type": "string"
}
},
"type": "object"
},
"max_header_list_size": {
"type": "integer"
},
"max_receive_message_size": {
"type": "integer"
},
"max_send_msg_size": {
"type": "integer"
},
"read_buffer_size": {
"type": "integer"
},
"write_buffer_size": {
"type": "integer"
}
},
"type": "object"
},
"mode": {
"type": "string"
},
"network": {
"type": "string"
},
"probe_wait_time": {
"type": "string"
},
"restart": {
"type": "boolean"
},
"socket_path": {
"type": "string"
}
},
"type": "object"
},
"servicePort": {
"type": "integer"
}
},
"type": "object"
},
"rest": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"tls": {
"properties": {
"ca": {
"type": "string"
},
"cert": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"insecure_skip_verify": {
"description": "enable/disable skip SSL certificate verification",
"type": "boolean"
},
"key": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"annotations": {
"description": "service annotations",
"type": "object"
},
"enabled": {
"description": "service enabled",
"type": "boolean"
},
"externalTrafficPolicy": {
"description": "external traffic policy (can be specified when service type is LoadBalancer or NodePort) : Cluster or Local",
"type": "string"
},
"labels": {
"description": "service labels",
"type": "object"
},
"type": {
"description": "service type: ClusterIP, LoadBalancer or NodePort",
"enum": [
"ClusterIP",
"LoadBalancer",
"NodePort"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"description": "service account will be created",
"type": "boolean"
},
"name": {
"description": "name of service account",
"type": "string"
}
},
"type": "object"
},
"time_zone": {
"description": "time_zone",
"type": "string"
},
"tolerations": {
"description": "tolerations",
"items": {
"type": "object"
},
"type": "array"
},
"version": {
"description": "version of benchmark-operator config",
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | ca4b415cf1bcbe2dc7b2fabe918e3f250600fe9c | 2023-03-29T16:27:15 | charts/vald-helm-operator/values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"affinity": {
"description": "affinity",
"type": "object"
},
"annotations": {
"description": "deployment annotations",
"type": "object"
},
"enableLeaderElection": {
"description": "enable leader election for controller manager.",
"type": "boolean"
},
"enableMetrics": {
"description": "enable metrics endpoint",
"type": "boolean"
},
"healthPort": {
"description": "port of health endpoint",
"type": "integer"
},
"image": {
"properties": {
"pullPolicy": {
"description": "image pull policy",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"description": "image repository",
"type": "string"
},
"tag": {
"description": "image tag",
"type": "string"
}
},
"type": "object"
},
"leaderElectionID": {
"description": "name of the configmap that is used for holding the leader lock.",
"type": "string"
},
"livenessProbe": {
"properties": {
"enabled": {
"description": "enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"logging": {
"properties": {
"format": {
"description": "logging format of operator (console or json)",
"enum": [
"console",
"json"
],
"type": "string"
},
"level": {
"description": "logging level of operator (debug, info, or error)",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
},
"stacktraceLevel": {
"description": "minimum log level triggers stacktrace generation",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
}
},
"type": "object"
},
"maxConcurrentReconciles": {
"description": "max number of concurrent reconciles",
"type": "integer"
},
"metricsPort": {
"description": "port of metrics endpoint",
"type": "integer"
},
"name": {
"description": "name of the deployment",
"type": "string"
},
"namespaced": {
"description": "if it is true, operator will behave as a namespace-scoped operator, if it is false, it will behave as a cluster-scoped operator.",
"type": "boolean"
},
"nodeSelector": {
"description": "node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"description": "pod annotations",
"type": "object"
},
"podSecurityContext": {
"description": "security context for pod",
"type": "object"
},
"rbac": {
"properties": {
"create": {
"description": "required roles and rolebindings will be created",
"type": "boolean"
},
"name": {
"description": "name of roles and rolebindings",
"type": "string"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"enabled": {
"description": "enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"reconcilePeriod": {
"description": "reconcile duration of operator",
"type": "string"
},
"replicas": {
"description": "number of replicas",
"type": "integer"
},
"resources": {
"description": "kubernetes resources of pod",
"type": "object"
},
"securityContext": {
"description": "security context for container",
"type": "object"
},
"service": {
"properties": {
"annotations": {
"description": "service annotations",
"type": "object"
},
"enabled": {
"description": "service enabled",
"type": "boolean"
},
"externalTrafficPolicy": {
"description": "external traffic policy (can be specified when service type is LoadBalancer or NodePort) : Cluster or Local",
"type": "string"
},
"labels": {
"description": "service labels",
"type": "object"
},
"type": {
"description": "service type: ClusterIP, LoadBalancer or NodePort",
"enum": [
"ClusterIP",
"LoadBalancer",
"NodePort"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"description": "service account will be created",
"type": "boolean"
},
"name": {
"description": "name of service account",
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"description": "tolerations",
"items": {
"type": "object"
},
"type": "array"
},
"watchNamespaces": {
"description": "comma separated names of namespaces to watch, if it is empty, the namespace that the operator exists in is used.",
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
vdaas/vald | 8886352f66410814d698fa64cad86a482dae8885 | 2023-04-25T03:16:38 | charts/vald-helm-operator/values.schema.json | 1,470 | 2024-05-29T13:35:19.969685Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"affinity": {
"description": "affinity",
"type": "object"
},
"annotations": {
"description": "deployment annotations",
"type": "object"
},
"enableLeaderElection": {
"description": "enable leader election for controller manager.",
"type": "boolean"
},
"enableMetrics": {
"description": "enable metrics endpoint",
"type": "boolean"
},
"healthPort": {
"description": "port of health endpoint",
"type": "integer"
},
"image": {
"properties": {
"pullPolicy": {
"description": "image pull policy",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"description": "image repository",
"type": "string"
},
"tag": {
"description": "image tag",
"type": "string"
}
},
"type": "object"
},
"leaderElectionID": {
"description": "name of the configmap that is used for holding the leader lock.",
"type": "string"
},
"livenessProbe": {
"properties": {
"enabled": {
"description": "enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"logging": {
"properties": {
"format": {
"description": "logging format of operator (console or json)",
"enum": [
"console",
"json"
],
"type": "string"
},
"level": {
"description": "logging level of operator (debug, info, or error)",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
},
"stacktraceLevel": {
"description": "minimum log level triggers stacktrace generation",
"enum": [
"debug",
"info",
"error"
],
"type": "string"
}
},
"type": "object"
},
"maxConcurrentReconciles": {
"description": "max number of concurrent reconciles",
"type": "integer"
},
"metricsPort": {
"description": "port of metrics endpoint",
"type": "integer"
},
"name": {
"description": "name of the deployment",
"type": "string"
},
"namespaced": {
"description": "if it is true, operator will behave as a namespace-scoped operator, if it is false, it will behave as a cluster-scoped operator.",
"type": "boolean"
},
"nodeSelector": {
"description": "node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"description": "pod annotations",
"type": "object"
},
"podSecurityContext": {
"description": "security context for pod",
"type": "object"
},
"rbac": {
"properties": {
"create": {
"description": "required roles and rolebindings will be created",
"type": "boolean"
},
"name": {
"description": "name of roles and rolebindings",
"type": "string"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"enabled": {
"description": "enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"description": "liveness probe failure threshold",
"type": "integer"
},
"httpGet": {
"properties": {
"path": {
"description": "readiness probe path",
"type": "string"
},
"port": {
"description": "readiness probe port",
"type": "string"
},
"scheme": {
"description": "readiness probe scheme",
"type": "string"
}
},
"type": "object"
},
"initialDelaySeconds": {
"description": "liveness probe initial delay seconds",
"type": "integer"
},
"periodSeconds": {
"description": "liveness probe period seconds",
"type": "integer"
},
"successThreshold": {
"description": "liveness probe success threshold",
"type": "integer"
},
"timeoutSeconds": {
"description": "liveness probe timeout seconds",
"type": "integer"
}
},
"type": "object"
},
"reconcilePeriod": {
"description": "reconcile duration of operator",
"type": "string"
},
"replicas": {
"description": "number of replicas",
"type": "integer"
},
"resources": {
"description": "kubernetes resources of pod",
"type": "object"
},
"securityContext": {
"description": "security context for container",
"type": "object"
},
"service": {
"properties": {
"annotations": {
"description": "service annotations",
"type": "object"
},
"enabled": {
"description": "service enabled",
"type": "boolean"
},
"externalTrafficPolicy": {
"description": "external traffic policy (can be specified when service type is LoadBalancer or NodePort) : Cluster or Local",
"type": "string"
},
"labels": {
"description": "service labels",
"type": "object"
},
"type": {
"description": "service type: ClusterIP, LoadBalancer or NodePort",
"enum": [
"ClusterIP",
"LoadBalancer",
"NodePort"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"description": "service account will be created",
"type": "boolean"
},
"name": {
"description": "name of service account",
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"description": "tolerations",
"items": {
"type": "object"
},
"type": "array"
},
"watchNamespaces": {
"description": "comma separated names of namespaces to watch, if it is empty, the namespace that the operator exists in is used.",
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
apioo/psx-schema | 9a6dcac1732db0d220a2f3406370c39de79beb4b | 2021-10-21T19:59:53 | tests/Transformer/jsonschema/actual/00_jsonschema.json | 55 | 2024-05-28T05:13:40.603004Z | {
"$id": "https://example.com/product.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"Group": {
"properties": {
"name": {
"type": "string"
}
},
"type": "object"
}
},
"description": "A product from Acme's catalog",
"properties": {
"group": {
"$ref": "#/definitions/Group"
},
"nested": {
"properties": {
"foo": {
"type": "string"
}
},
"type": "object"
},
"price": {
"description": "The price of the product",
"exclusiveMinimum": 0,
"type": "number"
},
"productId": {
"description": "The unique identifier for a product",
"type": "integer"
},
"productName": {
"description": "Name of the product",
"type": "string"
},
"union": {
"oneOf": [
{
"$ref": "#/definitions/Group"
},
{
"properties": {
"foo": {
"type": "string"
}
},
"type": "object"
}
]
}
},
"required": [
"productId",
"productName",
"price"
],
"title": "Product",
"type": "object"
} | Apache-2.0 | en |
apioo/psx-schema | 4e8d3872dc8203bae6042636db10569c369464fe | 2021-10-19T20:08:30 | tests/Transformer/jsonschema/actual/00_jsonschema.json | 55 | 2024-05-28T05:13:40.603004Z | {
"$id": "https://example.com/product.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A product from Acme's catalog",
"properties": {
"nested": {
"properties": {
"foo": {
"type": "string"
}
},
"type": "object"
},
"price": {
"description": "The price of the product",
"exclusiveMinimum": 0,
"type": "number"
},
"productId": {
"description": "The unique identifier for a product",
"type": "integer"
},
"productName": {
"description": "Name of the product",
"type": "string"
}
},
"required": [
"productId",
"productName",
"price"
],
"title": "Product",
"type": "object"
} | Apache-2.0 | en |
scipp/sciline | 869cafd0697b7bf6df85c45dc44bf21977c891fb | 2024-02-12T14:42:14 | src/sciline/serialize/graph_json_schema.json | 9 | 2024-05-27T08:36:23.195536Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A task graph from the Sciline package (https://scipp.github.io/sciline/).",
"properties": {
"directed": {
"description": "Indicates whether the graph is directed. Always true in Sciline.",
"type": "boolean"
},
"edges": {
"description": "A directed edge that connects from 'source' to 'target'.",
"items": {
"properties": {
"source": {
"description": "Id of the source node of the edge.",
"type": "string"
},
"target": {
"description": "Id of the target node of the edge.",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"type": "array"
},
"multigraph": {
"description": "Indicates whether the graph has multi-edges. Always false in Sciline.",
"type": "boolean"
},
"nodes": {
"items": {
"allOf": [
{
"if": {
"properties": {
"kind": {
"const": "data"
}
}
},
"then": {
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
}
},
{
"if": {
"properties": {
"kind": {
"const": "data_table_cell"
}
}
},
"then": {
"properties": {
"row_indices": {
"items": {
"type": "string"
},
"type": "array"
},
"row_types": {
"items": {
"type": "string"
},
"type": "array"
},
"value_type": {
"type": "string"
}
},
"required": [
"value_type",
"row_types",
"row_indices"
]
}
},
{
"if": {
"properties": {
"kind": {
"const": "p_function"
}
}
},
"then": {
"properties": {
"function": {
"type": "string"
}
},
"required": [
"function"
]
}
},
{
"if": {
"properties": {
"kind": {
"const": "p_parameter"
}
}
},
"then": {
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
}
},
{
"if": {
"properties": {
"kind": {
"const": "p_series"
}
}
},
"then": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array"
},
"row_dim": {
"type": "string"
},
"value_type": {
"type": "string"
}
},
"required": [
"value_type",
"row_dim",
"labels"
]
}
}
],
"description": "A node in the graph",
"properties": {
"id": {
"description": "Unique id of the node.",
"type": "string"
},
"kind": {
"description": "Indicates what kind of object the node represents. Determines the schema of the node.",
"enum": [
"data",
"data_table_cell",
"p_function",
"p_parameter",
"p_series",
"p_table_cell"
],
"type": "string"
},
"label": {
"description": "Human-readable label; not necessarily unique.",
"type": "string"
}
},
"required": [
"id",
"label",
"kind"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"directed",
"edges",
"multigraph",
"nodes"
],
"title": "Sciline task graph",
"type": "object"
} | BSD-3-Clause | en |
scipp/sciline | c7ae8e61883bbbf34c2053fba4a3128d887ea777 | 2024-03-01T11:55:45 | src/sciline/serialize/graph_json_schema.json | 9 | 2024-05-27T08:36:23.195536Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A task graph from the Sciline package (https://scipp.github.io/sciline/).",
"properties": {
"directed": {
"description": "Indicates whether the graph is directed. Always true in Sciline.",
"type": "boolean"
},
"edges": {
"description": "Array of directed edges in the graph.",
"items": {
"description": "A directed edge that connects from 'source' to 'target'.",
"properties": {
"id": {
"description": "Unique id of the edge.",
"type": "string"
},
"source": {
"description": "Id of the source node of the edge.",
"type": "string"
},
"target": {
"description": "Id of the target node of the edge.",
"type": "string"
}
},
"required": [
"id",
"source",
"target"
],
"type": "object"
},
"type": "array"
},
"multigraph": {
"description": "Indicates whether the graph has multi-edges. Always false in Sciline.",
"type": "boolean"
},
"nodes": {
"description": "Array of nodes in the graph.",
"items": {
"allOf": [
{
"if": {
"properties": {
"kind": {
"const": "function"
}
}
},
"then": {
"properties": {
"args": {
"description": "Ids of edges that connect to the positional arguments of this function in the order of the function arguments.",
"items": {
"type": "string"
},
"type": "array"
},
"function": {
"description": "Fully qualified name of the function that implements this node.",
"type": "string"
},
"kwargs": {
"additionalProperties": {
"type": "string"
},
"description": "Edges that connect to the keyword arguments of this function where the property name is the argument name and the property value an edge id.",
"type": "object"
}
},
"required": [
"function",
"args",
"kwargs"
]
}
}
],
"description": "A node in the graph",
"properties": {
"id": {
"description": "Unique id of the node.",
"type": "string"
},
"kind": {
"description": "Indicates what kind of object the node represents. Determines the schema of the node.",
"enum": [
"function",
"parameter"
],
"type": "string"
},
"label": {
"description": "Human-readable label; not necessarily unique.",
"type": "string"
},
"out": {
"description": "Fully qualified name of the type of object produced by this node.",
"type": "string"
}
},
"required": [
"id",
"label",
"kind",
"out"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"directed",
"edges",
"multigraph",
"nodes"
],
"title": "Sciline task graph",
"type": "object"
} | BSD-3-Clause | en |
scipp/sciline | f866da6ca4c80ab05f3ea5b8f6fb20473092ec2f | 2024-03-11T10:53:42 | src/sciline/serialize/graph_json_schema.json | 9 | 2024-05-27T08:36:23.195536Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A task graph from the Sciline package (https://scipp.github.io/sciline/).",
"properties": {
"directed": {
"description": "Indicates whether the graph is directed. Always true in Sciline.",
"type": "boolean"
},
"edges": {
"description": "Array of directed edges in the graph.",
"items": {
"description": "A directed edge that connects from 'source' to 'target'.",
"properties": {
"id": {
"description": "Unique id of the edge.",
"type": "string"
},
"source": {
"description": "Id of the source node of the edge.",
"type": "string"
},
"target": {
"description": "Id of the target node of the edge.",
"type": "string"
}
},
"required": [
"id",
"source",
"target"
],
"type": "object"
},
"type": "array"
},
"multigraph": {
"description": "Indicates whether the graph has multi-edges. Always false in Sciline.",
"type": "boolean"
},
"nodes": {
"description": "Array of nodes in the graph.",
"items": {
"allOf": [
{
"if": {
"properties": {
"kind": {
"const": "function"
}
}
},
"then": {
"properties": {
"args": {
"description": "Ids of edges that connect to the positional arguments of this function in the order of the function arguments.",
"items": {
"type": "string"
},
"type": "array"
},
"function": {
"description": "Fully qualified name of the function that implements this node.",
"type": "string"
},
"kwargs": {
"additionalProperties": {
"type": "string"
},
"description": "Edges that connect to the keyword arguments of this function where the property name is the argument name and the property value an edge id.",
"type": "object"
}
},
"required": [
"function",
"args",
"kwargs"
]
}
},
{
"if": {
"properties": {
"kind": {
"const": "data"
}
}
},
"then": {
"properties": {
"type": {
"description": "Fully qualified name of the Python (domain) type representing this node.",
"type": "string"
}
},
"required": [
"type"
]
}
}
],
"description": "A node in the graph",
"properties": {
"id": {
"description": "Unique id of the node.",
"type": "string"
},
"kind": {
"description": "Indicates what kind of object the node represents. Determines the schema of the node.",
"enum": [
"function",
"data"
],
"type": "string"
},
"label": {
"description": "Human-readable label; not necessarily unique.",
"type": "string"
}
},
"required": [
"id",
"label",
"kind"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"directed",
"edges",
"multigraph",
"nodes"
],
"title": "Sciline task graph",
"type": "object"
} | BSD-3-Clause | en |
oracle/oci-secrets-store-csi-driver-provider | 8e08381e31b6d51891e04330e8d2b13d39276ae8 | 2023-01-30T12:57:58 | charts/oci-secrets-store-csi-driver-provider/values.schema.json | 14 | 2024-05-27T06:55:27.80595Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"provider": {
"additionalProperties": false,
"description": "Values for OCI Vault provider templates",
"properties": {
"enableProfile": {
"description": "Enable Profiling",
"type": "boolean"
},
"endpoint": {
"description": "Socket endpoint for api connections",
"type": "string"
},
"endpointPermissions": {
"description": "Permissions for the socket",
"type": "integer"
},
"healthzPort": {
"description": "Liveness probe port",
"type": "integer"
},
"image": {
"additionalProperties": false,
"description": "Provider container image",
"properties": {
"pullPolicy": {
"enum": [
"IfNotPresent",
"Always",
"Never"
],
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"repository",
"pullPolicy",
"tag"
],
"type": "object"
},
"imagePullSecrets": {
"additionalProperties": false,
"description": "K8S secrets with registry credentials",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"metricsBackend": {
"description": "Metrics backend module",
"type": "string"
},
"metricsPort": {
"description": "Metrics port",
"type": "integer"
},
"oci": {
"description": "OCI specific settings",
"properties": {
"additionalProperties": false,
"auth": {
"description": "Settings for OCI authentication",
"properties": {
"additionalProperties": false,
"types": {
"description": "OCI authentication principal information",
"properties": {
"additionalProperties": false,
"instance": {
"description": "Settings for OCI authentication",
"properties": {
"enabled": {
"description": "Settings for OCI authentication",
"type": "boolean"
}
},
"type": "object"
},
"user": {
"description": "Settings for OCI authentication",
"properties": {
"enabled": {
"description": "Settings for OCI authentication",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"profilingPort": {
"description": "Profiling port",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"description": "Provider container resources",
"properties": {
"limits": {
"additionalProperties": false,
"description": "Resources limit",
"properties": {
"cpu": {
"pattern": "^\\d+(m)?$",
"type": "string"
},
"memory": {
"pattern": "^\\d+(Mi)?$",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"type": "object"
},
"requests": {
"additionalProperties": false,
"description": "Amount of resources to request",
"properties": {
"cpu": {
"pattern": "^\\d+(m)?$",
"type": "string"
},
"memory": {
"pattern": "^\\d+(Mi)?$",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"type": "object"
},
"socketHostDir": {
"description": "Host directory with sockets for various providers",
"type": "string"
}
},
"required": [
"image",
"resources",
"imagePullSecrets",
"oci",
"socketHostDir"
],
"type": "object"
},
"secrets-store-csi-driver": {
"description": "Values for Secrets Store CSI driver",
"properties": {
"enableSecretRotation": {
"type": "boolean"
},
"install": {
"type": "boolean"
},
"rotationPollInterval": {
"type": "string"
},
"syncSecret": {
"description": "Install RBAC roles and bindings required for K8S Secrets syncing if enabled",
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
},
"required": [
"install",
"syncSecret"
],
"type": "object"
}
},
"required": [
"provider",
"secrets-store-csi-driver"
],
"title": "Values",
"type": "object"
} | UPL-1.0 | en |
oracle/oci-secrets-store-csi-driver-provider | d76351a76d6697a0c2c2f679edbdbee12c5a0fbd | 2024-05-29T08:16:24 | charts/oci-secrets-store-csi-driver-provider/values.schema.json | 14 | 2024-05-27T06:55:27.80595Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"provider": {
"additionalProperties": false,
"description": "Values for OCI Vault provider templates",
"properties": {
"enableProfile": {
"description": "Enable Profiling",
"type": "boolean"
},
"endpoint": {
"description": "Socket endpoint for api connections",
"type": "string"
},
"endpointPermissions": {
"description": "Permissions for the socket",
"type": "integer"
},
"healthzPort": {
"description": "Liveness probe port",
"type": "integer"
},
"image": {
"additionalProperties": false,
"description": "Provider container image",
"properties": {
"pullPolicy": {
"enum": [
"IfNotPresent",
"Always",
"Never"
],
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"repository",
"pullPolicy",
"tag"
],
"type": "object"
},
"imagePullSecrets": {
"additionalProperties": false,
"description": "K8S secrets with registry credentials",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"metricsBackend": {
"description": "Metrics backend module",
"type": "string"
},
"metricsPort": {
"description": "Metrics port",
"type": "integer"
},
"oci": {
"description": "OCI specific settings",
"properties": {
"additionalProperties": false,
"auth": {
"description": "Settings for OCI authentication",
"properties": {
"additionalProperties": false,
"types": {
"description": "OCI authentication principal information",
"properties": {
"additionalProperties": false,
"instance": {
"description": "Settings for OCI authentication",
"properties": {
"enabled": {
"description": "Settings for OCI authentication",
"type": "boolean"
}
},
"type": "object"
},
"user": {
"description": "Settings for OCI authentication",
"properties": {
"enabled": {
"description": "Settings for OCI authentication",
"type": "boolean"
}
},
"type": "object"
},
"workload": {
"description": "Settings for OCI Workload authentication",
"properties": {
"enabled": {
"description": "Settings for OCI Workload authentication",
"type": "boolean"
},
"resourcePrincipalRegion": {
"description": "Settings for OCI Workload authentication",
"type": "string"
},
"resourcePrincipalVersion": {
"description": "Settings for OCI Workload authentication",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"profilingPort": {
"description": "Profiling port",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"description": "Provider container resources",
"properties": {
"limits": {
"additionalProperties": false,
"description": "Resources limit",
"properties": {
"cpu": {
"pattern": "^\\d+(m)?$",
"type": "string"
},
"memory": {
"pattern": "^\\d+(Mi)?$",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"type": "object"
},
"requests": {
"additionalProperties": false,
"description": "Amount of resources to request",
"properties": {
"cpu": {
"pattern": "^\\d+(m)?$",
"type": "string"
},
"memory": {
"pattern": "^\\d+(Mi)?$",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"type": "object"
},
"socketHostDir": {
"description": "Host directory with sockets for various providers",
"type": "string"
}
},
"required": [
"image",
"resources",
"imagePullSecrets",
"oci",
"socketHostDir"
],
"type": "object"
},
"secrets-store-csi-driver": {
"description": "Values for Secrets Store CSI driver",
"properties": {
"enableSecretRotation": {
"type": "boolean"
},
"install": {
"type": "boolean"
},
"rotationPollInterval": {
"type": "string"
},
"syncSecret": {
"description": "Install RBAC roles and bindings required for K8S Secrets syncing if enabled",
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
},
"required": [
"install",
"syncSecret"
],
"type": "object"
}
},
"required": [
"provider",
"secrets-store-csi-driver"
],
"title": "Values",
"type": "object"
} | UPL-1.0 | en |
risingwavelabs/risingwave | 61ab2cd61a50c96891af1077590b977e837e6d5a | 2023-08-29T05:24:46 | src/connector/src/test_data/complex-schema.json | 6,408 | 2024-05-29T10:03:22.098773Z | {
"$id": "https://example.com/product.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A product from Acme's catalog",
"properties": {
"dimensions": {
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"width": {
"type": "number"
}
},
"required": [
"length",
"width",
"height"
],
"type": "object"
},
"price": {
"description": "The price of the product",
"exclusiveMinimum": 0,
"type": "number"
},
"productId": {
"description": "The unique identifier for a product",
"type": "integer"
},
"productName": {
"description": "Name of the product",
"type": "string"
},
"tags": {
"description": "Tags for the product",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"productId",
"productName",
"price"
],
"title": "Product",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | 6380dae7d73cb84fa663ff9693528f11e8fcdfe9 | 2022-10-19T09:33:28 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "name of CF admin user",
"type": "string"
}
},
"required": [
"adminUserName"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | 8c9805b7731343392b242897fff98165f5ab3b7e | 2023-06-15T16:50:15 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"api": {
"properties": {
"apiServer": {
"properties": {
"internalPort": {
"description": "Port used internally by the API container.",
"type": "integer"
},
"port": {
"description": "API external port. Defaults to `443`.",
"type": "integer"
},
"timeouts": {
"description": "HTTP timeouts.",
"properties": {
"idle": {
"description": "Idle timeout.",
"type": "integer"
},
"read": {
"description": "Read timeout.",
"type": "integer"
},
"readHeader": {
"description": "Read header timeout.",
"type": "integer"
},
"write": {
"description": "Write timeout.",
"type": "integer"
}
},
"required": [
"read",
"write",
"idle",
"readHeader"
],
"type": "object"
},
"url": {
"description": "API URL.",
"type": "string"
}
},
"required": [
"url",
"port",
"internalPort",
"timeouts"
],
"type": "object"
},
"authProxy": {
"description": "Needed if using a cluster authentication proxy, e.g. [Pinniped](https://pinniped.dev/).",
"properties": {
"caCert": {
"description": "Proxy's PEM-encoded CA certificate (*not* as Base64).",
"type": "string"
},
"host": {
"description": "Must be a host string, a host:port pair, or a URL to the base of the apiserver.",
"type": "string"
}
},
"type": "object"
},
"builderName": {
"description": "ID of the builder used to build apps. Defaults to `kpack-image-builder`.",
"type": "string"
},
"expose": {
"description": "Expose the API component via Contour. Set to false if you want to expose the API using other means.",
"type": "boolean"
},
"image": {
"description": "Reference to the API container image.",
"type": "string"
},
"include": {
"description": "Deploy the API component.",
"type": "boolean"
},
"lifecycle": {
"description": "Default lifecycle for apps.",
"properties": {
"stack": {
"description": "Stack.",
"type": "string"
},
"stagingRequirements": {
"properties": {
"diskMB": {
"description": "Disk in MB for staging.",
"type": "integer"
},
"memoryMB": {
"description": "Memory in MB for staging.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskMB"
],
"type": "object"
},
"type": {
"description": "Lifecycle type (only `buildpack` accepted currently).",
"enum": [
"buildpack"
],
"type": "string"
}
},
"required": [
"type",
"stack",
"stagingRequirements"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"userCertificateExpirationWarningDuration": {
"description": "Issue a warning if the user certificate provided for login has a long expiry. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format.",
"type": "string"
}
},
"required": [
"include",
"expose",
"apiServer",
"image",
"lifecycle",
"builderName",
"userCertificateExpirationWarningDuration"
],
"type": "object"
},
"contourRouter": {
"properties": {
"include": {
"description": "Deploy the `contour-router` component.",
"type": "boolean"
}
},
"required": [
"include"
],
"type": "object"
},
"controllers": {
"properties": {
"extraVCAPApplicationValues": {
"description": "Key-value pairs that are going to be set in the VCAP_APPLICATION env var on apps. Nested values are not supported.",
"properties": {},
"type": "object"
},
"image": {
"description": "Reference to the controllers container image.",
"type": "string"
},
"maxRetainedBuildsPerApp": {
"description": "How many staged builds to keep, excluding the app's current droplet. Older staged builds will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"maxRetainedPackagesPerApp": {
"description": "How many 'ready' packages to keep, excluding the package associated with the app's current droplet. Older 'ready' packages will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"namespaceLabels": {
"description": "Key-value pairs that are going to be set as labels on the namespaces created by Korifi.",
"properties": {},
"type": "object"
},
"processDefaults": {
"properties": {
"diskQuotaMB": {
"description": "Default disk quota for the `web` process.",
"type": "integer"
},
"memoryMB": {
"description": "Default memory limit for the `web` process.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskQuotaMB"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"taskTTL": {
"description": "How long before the `CFTask` object is deleted after the task has completed. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"workloadsTLSSecret": {
"description": "TLS secret used when setting up an app routes.",
"type": "string"
}
},
"required": [
"image",
"taskTTL",
"workloadsTLSSecret"
],
"type": "object"
},
"global": {
"description": "Global values that are shared between Korifi and its subcharts.",
"properties": {
"containerRegistrySecret": {
"description": "Name of the `Secret` to use when pushing or pulling from package, droplet and kpack-build repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"type": "string"
},
"containerRepositoryPrefix": {
"description": "The prefix of the container repository where package and droplet images will be pushed. This is suffixed with the app GUID and `-packages` or `-droplets`. For example, a value of `index.docker.io/korifi/` will result in `index.docker.io/korifi/<appGUID>-packages` and `index.docker.io/korifi/<appGUID>-droplets` being pushed.",
"pattern": "^[a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*/?$",
"type": "string"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"logLevel": {
"description": "Sets level of logging for api and controllers components. Can be 'info' or 'debug'.",
"enum": [
"info",
"debug"
],
"type": "string"
},
"reconcilers": {
"properties": {
"app": {
"description": "ID of the workload runner to set on all `AppWorkload` objects. Defaults to `statefulset-runner`.",
"type": "string"
},
"build": {
"description": "ID of the image builder to set on all `BuildWorkload` objects. Has to match `api.builderName`. Defaults to `kpack-image-builder`.",
"type": "string"
}
},
"required": [
"build",
"run"
],
"type": "object"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
}
},
"required": [
"containerRepositoryPrefix",
"defaultAppDomainName",
"logLevel",
"reconcilers",
"rootNamespace"
],
"type": "object"
},
"jobTaskRunner": {
"properties": {
"include": {
"description": "Deploy the `job-task-runner` component.",
"type": "boolean"
},
"jobTTL": {
"description": "How long before the `Job` backing up a task is deleted after completion. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"jobTTL"
],
"type": "object"
},
"kpackImageBuilder": {
"properties": {
"builderReadinessTimeout": {
"description": "The time that the kpack Builder will be waited for if not in ready state, berfore the build workload fails. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"builderRepository": {
"description": "Container image repository to store the `ClusterBuilder` image. Required when `clusterBuilderName` is not provided.",
"pattern": "^([a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*)?$",
"type": "string"
},
"clusterBuilderName": {
"description": "The name of the `ClusterBuilder` Kpack has been configured with. Leave blank to let `kpack-image-builder` create an example `ClusterBuilder`.",
"type": "string"
},
"clusterStackBuildImage": {
"description": "The image to use for building defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"clusterStackRunImage": {
"description": "The image to use for running defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"include": {
"description": "Deploy the `kpack-image-builder` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"builderReadinessTimeout"
],
"type": "object"
},
"statefulsetRunner": {
"properties": {
"include": {
"description": "Deploy the `statefulset-runner` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
}
},
"required": [
"global",
"adminUserName",
"api",
"controllers",
"kpackImageBuilder",
"statefulsetRunner",
"jobTaskRunner"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | a426011560e4a3f1e04cd38c4c07d1e18c68690e | 2023-08-15T09:20:22 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"api": {
"properties": {
"apiServer": {
"properties": {
"internalPort": {
"description": "Port used internally by the API container.",
"type": "integer"
},
"port": {
"description": "API external port. Defaults to `443`.",
"type": "integer"
},
"timeouts": {
"description": "HTTP timeouts.",
"properties": {
"idle": {
"description": "Idle timeout.",
"type": "integer"
},
"read": {
"description": "Read timeout.",
"type": "integer"
},
"readHeader": {
"description": "Read header timeout.",
"type": "integer"
},
"write": {
"description": "Write timeout.",
"type": "integer"
}
},
"required": [
"read",
"write",
"idle",
"readHeader"
],
"type": "object"
},
"url": {
"description": "API URL.",
"type": "string"
}
},
"required": [
"url",
"port",
"internalPort",
"timeouts"
],
"type": "object"
},
"authProxy": {
"description": "Needed if using a cluster authentication proxy, e.g. [Pinniped](https://pinniped.dev/).",
"properties": {
"caCert": {
"description": "Proxy's PEM-encoded CA certificate (*not* as Base64).",
"type": "string"
},
"host": {
"description": "Must be a host string, a host:port pair, or a URL to the base of the apiserver.",
"type": "string"
}
},
"type": "object"
},
"expose": {
"description": "Expose the API component via Contour. Set to false if you want to expose the API using other means.",
"type": "boolean"
},
"image": {
"description": "Reference to the API container image.",
"type": "string"
},
"include": {
"description": "Deploy the API component.",
"type": "boolean"
},
"lifecycle": {
"description": "Default lifecycle for apps.",
"properties": {
"stack": {
"description": "Stack.",
"type": "string"
},
"type": {
"description": "Lifecycle type (only `buildpack` accepted currently).",
"enum": [
"buildpack"
],
"type": "string"
}
},
"required": [
"type",
"stack"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"userCertificateExpirationWarningDuration": {
"description": "Issue a warning if the user certificate provided for login has a long expiry. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format.",
"type": "string"
}
},
"required": [
"include",
"expose",
"apiServer",
"image",
"lifecycle",
"userCertificateExpirationWarningDuration"
],
"type": "object"
},
"containerRegistrySecret": {
"deprecated": true,
"description": "Deprecated in favor of containerRegistrySecrets.",
"type": "string"
},
"containerRegistrySecrets": {
"description": "List of `Secret` names to use when pushing or pulling from package, droplet and kpack builder repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"items": {
"type": "string"
},
"type": "array"
},
"containerRepositoryPrefix": {
"description": "The prefix of the container repository where package and droplet images will be pushed. This is suffixed with the app GUID and `-packages` or `-droplets`. For example, a value of `index.docker.io/korifi/` will result in `index.docker.io/korifi/<appGUID>-packages` and `index.docker.io/korifi/<appGUID>-droplets` being pushed.",
"pattern": "^[a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*/?$",
"type": "string"
},
"contourRouter": {
"properties": {
"include": {
"description": "Deploy the `contour-router` component.",
"type": "boolean"
}
},
"required": [
"include"
],
"type": "object"
},
"controllers": {
"properties": {
"extraVCAPApplicationValues": {
"description": "Key-value pairs that are going to be set in the VCAP_APPLICATION env var on apps. Nested values are not supported.",
"properties": {},
"type": "object"
},
"image": {
"description": "Reference to the controllers container image.",
"type": "string"
},
"maxRetainedBuildsPerApp": {
"description": "How many staged builds to keep, excluding the app's current droplet. Older staged builds will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"maxRetainedPackagesPerApp": {
"description": "How many 'ready' packages to keep, excluding the package associated with the app's current droplet. Older 'ready' packages will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"namespaceLabels": {
"description": "Key-value pairs that are going to be set as labels on the namespaces created by Korifi.",
"properties": {},
"type": "object"
},
"processDefaults": {
"properties": {
"diskQuotaMB": {
"description": "Default disk quota for the `web` process.",
"type": "integer"
},
"memoryMB": {
"description": "Default memory limit for the `web` process.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskQuotaMB"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"taskTTL": {
"description": "How long before the `CFTask` object is deleted after the task has completed. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"workloadsTLSSecret": {
"description": "TLS secret used when setting up an app routes.",
"type": "string"
}
},
"required": [
"image",
"taskTTL",
"workloadsTLSSecret"
],
"type": "object"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"helm": {
"properties": {
"hooksImage": {
"description": "Image for the helm hooks containing kubectl",
"type": "string"
}
},
"type": "object"
},
"jobTaskRunner": {
"properties": {
"include": {
"description": "Deploy the `job-task-runner` component.",
"type": "boolean"
},
"jobTTL": {
"description": "How long before the `Job` backing up a task is deleted after completion. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"jobTTL"
],
"type": "object"
},
"kpackImageBuilder": {
"properties": {
"builderReadinessTimeout": {
"description": "The time that the kpack Builder will be waited for if not in ready state, berfore the build workload fails. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"builderRepository": {
"description": "Container image repository to store the `ClusterBuilder` image. Required when `clusterBuilderName` is not provided.",
"pattern": "^([a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*)?$",
"type": "string"
},
"clusterBuilderName": {
"description": "The name of the `ClusterBuilder` Kpack has been configured with. Leave blank to let `kpack-image-builder` create an example `ClusterBuilder`.",
"type": "string"
},
"clusterStackBuildImage": {
"description": "The image to use for building defined in the `ClusterStack`. Used when `clusterBuilderName` is blank.",
"type": "string"
},
"clusterStackID": {
"description": "The ID of the `ClusterStack`. Used when `clusterBuilderName` is blank.",
"type": "string"
},
"clusterStackRunImage": {
"description": "The image to use for running defined in the `ClusterStack`. Used when `clusterBuilderName` is blank.",
"type": "string"
},
"include": {
"description": "Deploy the `kpack-image-builder` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"builderReadinessTimeout"
],
"type": "object"
},
"logLevel": {
"description": "Sets level of logging for api and controllers components. Can be 'info' or 'debug'.",
"enum": [
"info",
"debug"
],
"type": "string"
},
"reconcilers": {
"properties": {
"app": {
"description": "ID of the workload runner to set on all `AppWorkload` objects. Defaults to `statefulset-runner`.",
"type": "string"
},
"build": {
"description": "ID of the image builder to set on all `BuildWorkload` objects. Defaults to `kpack-image-builder`.",
"type": "string"
}
},
"required": [
"build",
"run"
],
"type": "object"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
},
"stagingRequirements": {
"properties": {
"buildCacheMB": {
"description": "Persistent disk in MB for caching staging artifacts across builds.",
"type": "integer"
},
"diskMB": {
"description": "Ephemeral Disk request in MB for staging apps.",
"type": "integer"
},
"memoryMB": {
"description": "Memory request in MB for staging.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskMB",
"buildCacheMB"
],
"type": "object"
},
"statefulsetRunner": {
"properties": {
"include": {
"description": "Deploy the `statefulset-runner` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
}
},
"required": [
"adminUserName",
"containerRepositoryPrefix",
"defaultAppDomainName",
"logLevel",
"reconcilers",
"rootNamespace",
"stagingRequirements",
"api",
"controllers",
"kpackImageBuilder",
"statefulsetRunner",
"jobTaskRunner"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | 208952e2c4c02d800a15e6a1c7d64984cba71334 | 2023-01-17T14:33:41 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"api": {
"properties": {
"apiServer": {
"properties": {
"internalPort": {
"description": "Port used internally by the API container.",
"type": "integer"
},
"port": {
"description": "API external port. Defaults to `443`.",
"type": "integer"
},
"timeouts": {
"description": "HTTP timeouts.",
"properties": {
"idle": {
"description": "Idle timeout.",
"type": "integer"
},
"read": {
"description": "Read timeout.",
"type": "integer"
},
"readHeader": {
"description": "Read header timeout.",
"type": "integer"
},
"write": {
"description": "Write timeout.",
"type": "integer"
}
},
"required": [
"read",
"write",
"idle",
"readHeader"
],
"type": "object"
},
"url": {
"description": "API URL.",
"type": "string"
}
},
"required": [
"url",
"port",
"internalPort",
"timeouts"
],
"type": "object"
},
"authProxy": {
"description": "Needed if using a cluster authentication proxy, e.g. [Pinniped](https://pinniped.dev/).",
"properties": {
"caCert": {
"description": "Proxy's PEM-encoded CA certificate (*not* as Base64).",
"type": "string"
},
"host": {
"description": "Must be a host string, a host:port pair, or a URL to the base of the apiserver.",
"type": "string"
}
},
"type": "object"
},
"builderName": {
"description": "ID of the builder used to build apps. Defaults to `kpack-image-builder`.",
"type": "string"
},
"expose": {
"description": "Expose the API component via Contour. Set to false if you want to expose the API using other means.",
"type": "boolean"
},
"image": {
"description": "Reference to the API container image.",
"type": "string"
},
"include": {
"description": "Deploy the API component.",
"type": "boolean"
},
"lifecycle": {
"description": "Default lifecycle for apps.",
"properties": {
"stack": {
"description": "Stack.",
"type": "string"
},
"stagingRequirements": {
"properties": {
"diskMB": {
"description": "Disk in MB for staging.",
"type": "integer"
},
"memoryMB": {
"description": "Memory in MB for staging.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskMB"
],
"type": "object"
},
"type": {
"description": "Lifecycle type (only `buildpack` accepted currently).",
"enum": [
"buildpack"
],
"type": "string"
}
},
"required": [
"type",
"stack",
"stagingRequirements"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"userCertificateExpirationWarningDuration": {
"description": "Issue a warning if the user certificate provided for login has a long expiry. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format.",
"type": "string"
}
},
"required": [
"include",
"expose",
"apiServer",
"image",
"lifecycle",
"builderName",
"userCertificateExpirationWarningDuration"
],
"type": "object"
},
"contourRouter": {
"properties": {
"include": {
"description": "Deploy the `contour-router` component.",
"type": "boolean"
}
},
"required": [
"include"
],
"type": "object"
},
"controllers": {
"properties": {
"image": {
"description": "Reference to the controllers container image.",
"type": "string"
},
"namespaceLabels": {
"description": "Key-value pairs that are going to be set as labels on the namespaces created by Korifi",
"properties": {},
"type": "object"
},
"processDefaults": {
"properties": {
"diskQuotaMB": {
"description": "Default disk quota for the `web` process.",
"type": "integer"
},
"memoryMB": {
"description": "Default memory limit for the `web` process.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskQuotaMB"
],
"type": "object"
},
"reconcilers": {
"properties": {
"app": {
"description": "ID of the workload runner to set on all `AppWorkload` objects. Defaults to `statefulset-runner`.",
"type": "string"
},
"build": {
"description": "ID of the image builder to set on all `BuildWorkload` objects. Has to match `api.builderName`. Defaults to `kpack-image-builder`.",
"type": "string"
}
},
"required": [
"build",
"app"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"taskTTL": {
"description": "How long before the `CFTask` object is deleted after the task has completed. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"workloadsTLSSecret": {
"description": "TLS secret used when setting up an app routes.",
"type": "string"
}
},
"required": [
"image",
"reconcilers",
"taskTTL",
"workloadsTLSSecret"
],
"type": "object"
},
"global": {
"description": "Global values that are shared between Korifi and its subcharts.",
"properties": {
"containerRegistrySecret": {
"description": "Name of the `Secret` to use when pushing or pulling from package, droplet and kpack-build repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"type": "string"
},
"containerRepositoryPrefix": {
"description": "The prefix of the container repository where package and droplet images will be pushed. This is suffixed with the app GUID and `-packages` or `-droplets`. For example, a value of `index.docker.io/korifi/` will result in `index.docker.io/korifi/<appGUID>-packages` and `index.docker.io/korifi/<appGUID>-droplets` being pushed.",
"type": "string"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
}
},
"required": [
"rootNamespace",
"containerRepositoryPrefix",
"defaultAppDomainName"
],
"type": "object"
},
"jobTaskRunner": {
"properties": {
"include": {
"description": "Deploy the `job-task-runner` component.",
"type": "boolean"
},
"jobTTL": {
"description": "How long before the `Job` backing up a task is deleted after completion. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"jobTTL"
],
"type": "object"
},
"kpackImageBuilder": {
"properties": {
"builderRepository": {
"description": "Container image repository to store the `ClusterBuilder` image. Required when `clusterBuilderName` is not provided.",
"type": "string"
},
"clusterBuilderName": {
"description": "The name of the `ClusterBuilder` Kpack has been configured with. Leave blank to let `kpack-image-builder` create an example `ClusterBuilder`.",
"type": "string"
},
"clusterStackBuildImage": {
"description": "The image to use for building defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"clusterStackRunImage": {
"description": "The image to use for running defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"include": {
"description": "Deploy the `kpack-image-builder` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
},
"statefulsetRunner": {
"properties": {
"include": {
"description": "Deploy the `statefulset-runner` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
}
},
"required": [
"global",
"adminUserName",
"api",
"controllers",
"kpackImageBuilder",
"statefulsetRunner",
"jobTaskRunner"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | d8bdf28b0b958695a043c6353391e96df58ee600 | 2023-02-21T12:12:22 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"api": {
"properties": {
"apiServer": {
"properties": {
"internalPort": {
"description": "Port used internally by the API container.",
"type": "integer"
},
"port": {
"description": "API external port. Defaults to `443`.",
"type": "integer"
},
"timeouts": {
"description": "HTTP timeouts.",
"properties": {
"idle": {
"description": "Idle timeout.",
"type": "integer"
},
"read": {
"description": "Read timeout.",
"type": "integer"
},
"readHeader": {
"description": "Read header timeout.",
"type": "integer"
},
"write": {
"description": "Write timeout.",
"type": "integer"
}
},
"required": [
"read",
"write",
"idle",
"readHeader"
],
"type": "object"
},
"url": {
"description": "API URL.",
"type": "string"
}
},
"required": [
"url",
"port",
"internalPort",
"timeouts"
],
"type": "object"
},
"authProxy": {
"description": "Needed if using a cluster authentication proxy, e.g. [Pinniped](https://pinniped.dev/).",
"properties": {
"caCert": {
"description": "Proxy's PEM-encoded CA certificate (*not* as Base64).",
"type": "string"
},
"host": {
"description": "Must be a host string, a host:port pair, or a URL to the base of the apiserver.",
"type": "string"
}
},
"type": "object"
},
"builderName": {
"description": "ID of the builder used to build apps. Defaults to `kpack-image-builder`.",
"type": "string"
},
"expose": {
"description": "Expose the API component via Contour. Set to false if you want to expose the API using other means.",
"type": "boolean"
},
"image": {
"description": "Reference to the API container image.",
"type": "string"
},
"include": {
"description": "Deploy the API component.",
"type": "boolean"
},
"lifecycle": {
"description": "Default lifecycle for apps.",
"properties": {
"stack": {
"description": "Stack.",
"type": "string"
},
"stagingRequirements": {
"properties": {
"diskMB": {
"description": "Disk in MB for staging.",
"type": "integer"
},
"memoryMB": {
"description": "Memory in MB for staging.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskMB"
],
"type": "object"
},
"type": {
"description": "Lifecycle type (only `buildpack` accepted currently).",
"enum": [
"buildpack"
],
"type": "string"
}
},
"required": [
"type",
"stack",
"stagingRequirements"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"userCertificateExpirationWarningDuration": {
"description": "Issue a warning if the user certificate provided for login has a long expiry. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format.",
"type": "string"
}
},
"required": [
"include",
"expose",
"apiServer",
"image",
"lifecycle",
"builderName",
"userCertificateExpirationWarningDuration"
],
"type": "object"
},
"contourRouter": {
"properties": {
"include": {
"description": "Deploy the `contour-router` component.",
"type": "boolean"
}
},
"required": [
"include"
],
"type": "object"
},
"controllers": {
"properties": {
"extraVCAPApplicationValues": {
"description": "Key-value pairs that are going to be set in the VCAP_APPLICATION env var on apps. Nested values are not supported.",
"properties": {},
"type": "object"
},
"image": {
"description": "Reference to the controllers container image.",
"type": "string"
},
"namespaceLabels": {
"description": "Key-value pairs that are going to be set as labels on the namespaces created by Korifi.",
"properties": {},
"type": "object"
},
"processDefaults": {
"properties": {
"diskQuotaMB": {
"description": "Default disk quota for the `web` process.",
"type": "integer"
},
"memoryMB": {
"description": "Default memory limit for the `web` process.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskQuotaMB"
],
"type": "object"
},
"reconcilers": {
"properties": {
"app": {
"description": "ID of the workload runner to set on all `AppWorkload` objects. Defaults to `statefulset-runner`.",
"type": "string"
},
"build": {
"description": "ID of the image builder to set on all `BuildWorkload` objects. Has to match `api.builderName`. Defaults to `kpack-image-builder`.",
"type": "string"
}
},
"required": [
"build",
"app"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"taskTTL": {
"description": "How long before the `CFTask` object is deleted after the task has completed. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"workloadsTLSSecret": {
"description": "TLS secret used when setting up an app routes.",
"type": "string"
}
},
"required": [
"image",
"reconcilers",
"taskTTL",
"workloadsTLSSecret"
],
"type": "object"
},
"global": {
"description": "Global values that are shared between Korifi and its subcharts.",
"properties": {
"containerRegistrySecret": {
"description": "Name of the `Secret` to use when pushing or pulling from package, droplet and kpack-build repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"type": "string"
},
"containerRepositoryPrefix": {
"description": "The prefix of the container repository where package and droplet images will be pushed. This is suffixed with the app GUID and `-packages` or `-droplets`. For example, a value of `index.docker.io/korifi/` will result in `index.docker.io/korifi/<appGUID>-packages` and `index.docker.io/korifi/<appGUID>-droplets` being pushed.",
"type": "string"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
}
},
"required": [
"rootNamespace",
"containerRepositoryPrefix",
"defaultAppDomainName"
],
"type": "object"
},
"jobTaskRunner": {
"properties": {
"include": {
"description": "Deploy the `job-task-runner` component.",
"type": "boolean"
},
"jobTTL": {
"description": "How long before the `Job` backing up a task is deleted after completion. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"jobTTL"
],
"type": "object"
},
"kpackImageBuilder": {
"properties": {
"builderRepository": {
"description": "Container image repository to store the `ClusterBuilder` image. Required when `clusterBuilderName` is not provided.",
"type": "string"
},
"clusterBuilderName": {
"description": "The name of the `ClusterBuilder` Kpack has been configured with. Leave blank to let `kpack-image-builder` create an example `ClusterBuilder`.",
"type": "string"
},
"clusterStackBuildImage": {
"description": "The image to use for building defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"clusterStackRunImage": {
"description": "The image to use for running defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"include": {
"description": "Deploy the `kpack-image-builder` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
},
"statefulsetRunner": {
"properties": {
"include": {
"description": "Deploy the `statefulset-runner` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
}
},
"required": [
"global",
"adminUserName",
"api",
"controllers",
"kpackImageBuilder",
"statefulsetRunner",
"jobTaskRunner"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | 83230e603740715be661299f3499791f5d300cf8 | 2024-01-12T15:07:10 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"api": {
"properties": {
"apiServer": {
"properties": {
"internalPort": {
"description": "Port used internally by the API container.",
"type": "integer"
},
"port": {
"description": "API external port. Defaults to `443`.",
"type": "integer"
},
"timeouts": {
"description": "HTTP timeouts.",
"properties": {
"idle": {
"description": "Idle timeout.",
"type": "integer"
},
"read": {
"description": "Read timeout.",
"type": "integer"
},
"readHeader": {
"description": "Read header timeout.",
"type": "integer"
},
"write": {
"description": "Write timeout.",
"type": "integer"
}
},
"required": [
"read",
"write",
"idle",
"readHeader"
],
"type": "object"
},
"url": {
"description": "API URL.",
"type": "string"
}
},
"required": [
"url",
"port",
"internalPort",
"timeouts"
],
"type": "object"
},
"authProxy": {
"description": "Needed if using a cluster authentication proxy, e.g. [Pinniped](https://pinniped.dev/).",
"properties": {
"caCert": {
"description": "Proxy's PEM-encoded CA certificate (*not* as Base64).",
"type": "string"
},
"host": {
"description": "Must be a host string, a host:port pair, or a URL to the base of the apiserver.",
"type": "string"
}
},
"type": "object"
},
"image": {
"description": "Reference to the API container image.",
"type": "string"
},
"include": {
"description": "Deploy the API component.",
"type": "boolean"
},
"lifecycle": {
"description": "Default lifecycle for apps.",
"properties": {
"stack": {
"description": "Stack.",
"type": "string"
},
"type": {
"description": "Lifecycle type (only `buildpack` accepted currently).",
"enum": [
"buildpack"
],
"type": "string"
}
},
"required": [
"type",
"stack"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"userCertificateExpirationWarningDuration": {
"description": "Issue a warning if the user certificate provided for login has a long expiry. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format.",
"type": "string"
}
},
"required": [
"include",
"apiServer",
"image",
"lifecycle",
"userCertificateExpirationWarningDuration"
],
"type": "object"
},
"containerRegistrySecret": {
"deprecated": true,
"description": "Deprecated in favor of containerRegistrySecrets.",
"type": "string"
},
"containerRegistrySecrets": {
"description": "List of `Secret` names to use when pushing or pulling from package, droplet and kpack builder repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"items": {
"type": "string"
},
"type": "array"
},
"containerRepositoryPrefix": {
"description": "The prefix of the container repository where package and droplet images will be pushed. This is suffixed with the app GUID and `-packages` or `-droplets`. For example, a value of `index.docker.io/korifi/` will result in `index.docker.io/korifi/<appGUID>-packages` and `index.docker.io/korifi/<appGUID>-droplets` being pushed.",
"pattern": "^[a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*/?$",
"type": "string"
},
"controllers": {
"properties": {
"extraVCAPApplicationValues": {
"description": "Key-value pairs that are going to be set in the VCAP_APPLICATION env var on apps. Nested values are not supported.",
"properties": {},
"type": "object"
},
"image": {
"description": "Reference to the controllers container image.",
"type": "string"
},
"maxRetainedBuildsPerApp": {
"description": "How many staged builds to keep, excluding the app's current droplet. Older staged builds will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"maxRetainedPackagesPerApp": {
"description": "How many 'ready' packages to keep, excluding the package associated with the app's current droplet. Older 'ready' packages will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"namespaceLabels": {
"description": "Key-value pairs that are going to be set as labels on the namespaces created by Korifi.",
"properties": {},
"type": "object"
},
"processDefaults": {
"properties": {
"diskQuotaMB": {
"description": "Default disk quota for the `web` process.",
"type": "integer"
},
"memoryMB": {
"description": "Default memory limit for the `web` process.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskQuotaMB"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"taskTTL": {
"description": "How long before the `CFTask` object is deleted after the task has completed. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"workloadsTLSSecret": {
"description": "TLS secret used when setting up an app routes.",
"type": "string"
}
},
"required": [
"image",
"taskTTL",
"workloadsTLSSecret"
],
"type": "object"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"helm": {
"properties": {
"hooksImage": {
"description": "Image for the helm hooks containing kubectl",
"type": "string"
}
},
"type": "object"
},
"jobTaskRunner": {
"properties": {
"include": {
"description": "Deploy the `job-task-runner` component.",
"type": "boolean"
},
"jobTTL": {
"description": "How long before the `Job` backing up a task is deleted after completion. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"jobTTL"
],
"type": "object"
},
"kpackImageBuilder": {
"properties": {
"builderReadinessTimeout": {
"description": "The time that the kpack Builder will be waited for if not in ready state, berfore the build workload fails. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"builderRepository": {
"description": "Container image repository to store the `ClusterBuilder` image. Required when `clusterBuilderName` is not provided.",
"pattern": "^([a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*)?$",
"type": "string"
},
"clusterBuilderName": {
"description": "The name of the `ClusterBuilder` Kpack has been configured with. Leave blank to let `kpack-image-builder` create an example `ClusterBuilder`.",
"type": "string"
},
"clusterStackBuildImage": {
"description": "The image to use for building defined in the `ClusterStack`. Used when `clusterBuilderName` is blank.",
"type": "string"
},
"clusterStackID": {
"description": "The ID of the `ClusterStack`. Used when `clusterBuilderName` is blank.",
"type": "string"
},
"clusterStackRunImage": {
"description": "The image to use for running defined in the `ClusterStack`. Used when `clusterBuilderName` is blank.",
"type": "string"
},
"include": {
"description": "Deploy the `kpack-image-builder` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"builderReadinessTimeout"
],
"type": "object"
},
"logLevel": {
"description": "Sets level of logging for api and controllers components. Can be 'info' or 'debug'.",
"enum": [
"info",
"debug"
],
"type": "string"
},
"networking": {
"description": "Networking configuration",
"properties": {
"gatewayClass": {
"description": "The name of the GatewayClass Korifi Gateway references",
"type": "string"
}
},
"required": [
"gatewayClass"
],
"type": "object"
},
"reconcilers": {
"properties": {
"app": {
"description": "ID of the workload runner to set on all `AppWorkload` objects. Defaults to `statefulset-runner`.",
"type": "string"
},
"build": {
"description": "ID of the image builder to set on all `BuildWorkload` objects. Defaults to `kpack-image-builder`.",
"type": "string"
}
},
"required": [
"build",
"run"
],
"type": "object"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
},
"stagingRequirements": {
"properties": {
"buildCacheMB": {
"description": "Persistent disk in MB for caching staging artifacts across builds.",
"type": "integer"
},
"diskMB": {
"description": "Ephemeral Disk request in MB for staging apps.",
"type": "integer"
},
"memoryMB": {
"description": "Memory request in MB for staging.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskMB",
"buildCacheMB"
],
"type": "object"
},
"statefulsetRunner": {
"properties": {
"include": {
"description": "Deploy the `statefulset-runner` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
},
"systemImagePullSecrets": {
"description": "List of `Secret` names to be used when pulling Korifi system images from private registries",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"adminUserName",
"containerRepositoryPrefix",
"defaultAppDomainName",
"logLevel",
"reconcilers",
"rootNamespace",
"stagingRequirements",
"api",
"controllers",
"kpackImageBuilder",
"statefulsetRunner",
"jobTaskRunner"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | a54e48a047ffa556bee7a8ed669adfda96c30c49 | 2023-04-28T12:41:22 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"api": {
"properties": {
"apiServer": {
"properties": {
"internalPort": {
"description": "Port used internally by the API container.",
"type": "integer"
},
"port": {
"description": "API external port. Defaults to `443`.",
"type": "integer"
},
"timeouts": {
"description": "HTTP timeouts.",
"properties": {
"idle": {
"description": "Idle timeout.",
"type": "integer"
},
"read": {
"description": "Read timeout.",
"type": "integer"
},
"readHeader": {
"description": "Read header timeout.",
"type": "integer"
},
"write": {
"description": "Write timeout.",
"type": "integer"
}
},
"required": [
"read",
"write",
"idle",
"readHeader"
],
"type": "object"
},
"url": {
"description": "API URL.",
"type": "string"
}
},
"required": [
"url",
"port",
"internalPort",
"timeouts"
],
"type": "object"
},
"authProxy": {
"description": "Needed if using a cluster authentication proxy, e.g. [Pinniped](https://pinniped.dev/).",
"properties": {
"caCert": {
"description": "Proxy's PEM-encoded CA certificate (*not* as Base64).",
"type": "string"
},
"host": {
"description": "Must be a host string, a host:port pair, or a URL to the base of the apiserver.",
"type": "string"
}
},
"type": "object"
},
"builderName": {
"description": "ID of the builder used to build apps. Defaults to `kpack-image-builder`.",
"type": "string"
},
"expose": {
"description": "Expose the API component via Contour. Set to false if you want to expose the API using other means.",
"type": "boolean"
},
"image": {
"description": "Reference to the API container image.",
"type": "string"
},
"include": {
"description": "Deploy the API component.",
"type": "boolean"
},
"lifecycle": {
"description": "Default lifecycle for apps.",
"properties": {
"stack": {
"description": "Stack.",
"type": "string"
},
"stagingRequirements": {
"properties": {
"diskMB": {
"description": "Disk in MB for staging.",
"type": "integer"
},
"memoryMB": {
"description": "Memory in MB for staging.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskMB"
],
"type": "object"
},
"type": {
"description": "Lifecycle type (only `buildpack` accepted currently).",
"enum": [
"buildpack"
],
"type": "string"
}
},
"required": [
"type",
"stack",
"stagingRequirements"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"userCertificateExpirationWarningDuration": {
"description": "Issue a warning if the user certificate provided for login has a long expiry. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format.",
"type": "string"
}
},
"required": [
"include",
"expose",
"apiServer",
"image",
"lifecycle",
"builderName",
"userCertificateExpirationWarningDuration"
],
"type": "object"
},
"contourRouter": {
"properties": {
"include": {
"description": "Deploy the `contour-router` component.",
"type": "boolean"
}
},
"required": [
"include"
],
"type": "object"
},
"controllers": {
"properties": {
"extraVCAPApplicationValues": {
"description": "Key-value pairs that are going to be set in the VCAP_APPLICATION env var on apps. Nested values are not supported.",
"properties": {},
"type": "object"
},
"image": {
"description": "Reference to the controllers container image.",
"type": "string"
},
"maxRetainedBuildsPerApp": {
"description": "How many staged builds to keep, excluding the app's current droplet. Older staged builds will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"maxRetainedPackagesPerApp": {
"description": "How many 'ready' packages to keep, excluding the package associated with the app's current droplet. Older 'ready' packages will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"namespaceLabels": {
"description": "Key-value pairs that are going to be set as labels on the namespaces created by Korifi.",
"properties": {},
"type": "object"
},
"processDefaults": {
"properties": {
"diskQuotaMB": {
"description": "Default disk quota for the `web` process.",
"type": "integer"
},
"memoryMB": {
"description": "Default memory limit for the `web` process.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskQuotaMB"
],
"type": "object"
},
"reconcilers": {
"properties": {
"app": {
"description": "ID of the workload runner to set on all `AppWorkload` objects. Defaults to `statefulset-runner`.",
"type": "string"
},
"build": {
"description": "ID of the image builder to set on all `BuildWorkload` objects. Has to match `api.builderName`. Defaults to `kpack-image-builder`.",
"type": "string"
}
},
"required": [
"build",
"app"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"taskTTL": {
"description": "How long before the `CFTask` object is deleted after the task has completed. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"workloadsTLSSecret": {
"description": "TLS secret used when setting up an app routes.",
"type": "string"
}
},
"required": [
"image",
"reconcilers",
"taskTTL",
"workloadsTLSSecret"
],
"type": "object"
},
"global": {
"description": "Global values that are shared between Korifi and its subcharts.",
"properties": {
"containerRegistrySecret": {
"description": "Name of the `Secret` to use when pushing or pulling from package, droplet and kpack-build repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"type": "string"
},
"containerRepositoryPrefix": {
"description": "The prefix of the container repository where package and droplet images will be pushed. This is suffixed with the app GUID and `-packages` or `-droplets`. For example, a value of `index.docker.io/korifi/` will result in `index.docker.io/korifi/<appGUID>-packages` and `index.docker.io/korifi/<appGUID>-droplets` being pushed.",
"pattern": "^[a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*/?$",
"type": "string"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"logLevel": {
"description": "Sets level of logging for api and controllers components. Can be 'info' or 'debug'.",
"enum": [
"info",
"debug"
],
"type": "string"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
}
},
"required": [
"rootNamespace",
"containerRepositoryPrefix",
"defaultAppDomainName",
"logLevel"
],
"type": "object"
},
"jobTaskRunner": {
"properties": {
"include": {
"description": "Deploy the `job-task-runner` component.",
"type": "boolean"
},
"jobTTL": {
"description": "How long before the `Job` backing up a task is deleted after completion. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"jobTTL"
],
"type": "object"
},
"kpackImageBuilder": {
"properties": {
"builderReadinessTimeout": {
"description": "The time that the kpack Builder will be waited for if not in ready state, berfore the build workload fails. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"builderRepository": {
"description": "Container image repository to store the `ClusterBuilder` image. Required when `clusterBuilderName` is not provided.",
"pattern": "^[a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*$",
"type": "string"
},
"clusterBuilderName": {
"description": "The name of the `ClusterBuilder` Kpack has been configured with. Leave blank to let `kpack-image-builder` create an example `ClusterBuilder`.",
"type": "string"
},
"clusterStackBuildImage": {
"description": "The image to use for building defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"clusterStackRunImage": {
"description": "The image to use for running defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"include": {
"description": "Deploy the `kpack-image-builder` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"builderReadinessTimeout"
],
"type": "object"
},
"statefulsetRunner": {
"properties": {
"include": {
"description": "Deploy the `statefulset-runner` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
}
},
"required": [
"global",
"adminUserName",
"api",
"controllers",
"kpackImageBuilder",
"statefulsetRunner",
"jobTaskRunner"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | cb13ea145283232abef0fe3eb3e0e923b53018cc | 2023-06-27T21:25:18 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"api": {
"properties": {
"apiServer": {
"properties": {
"internalPort": {
"description": "Port used internally by the API container.",
"type": "integer"
},
"port": {
"description": "API external port. Defaults to `443`.",
"type": "integer"
},
"timeouts": {
"description": "HTTP timeouts.",
"properties": {
"idle": {
"description": "Idle timeout.",
"type": "integer"
},
"read": {
"description": "Read timeout.",
"type": "integer"
},
"readHeader": {
"description": "Read header timeout.",
"type": "integer"
},
"write": {
"description": "Write timeout.",
"type": "integer"
}
},
"required": [
"read",
"write",
"idle",
"readHeader"
],
"type": "object"
},
"url": {
"description": "API URL.",
"type": "string"
}
},
"required": [
"url",
"port",
"internalPort",
"timeouts"
],
"type": "object"
},
"authProxy": {
"description": "Needed if using a cluster authentication proxy, e.g. [Pinniped](https://pinniped.dev/).",
"properties": {
"caCert": {
"description": "Proxy's PEM-encoded CA certificate (*not* as Base64).",
"type": "string"
},
"host": {
"description": "Must be a host string, a host:port pair, or a URL to the base of the apiserver.",
"type": "string"
}
},
"type": "object"
},
"builderName": {
"description": "ID of the builder used to build apps. Defaults to `kpack-image-builder`.",
"type": "string"
},
"expose": {
"description": "Expose the API component via Contour. Set to false if you want to expose the API using other means.",
"type": "boolean"
},
"image": {
"description": "Reference to the API container image.",
"type": "string"
},
"include": {
"description": "Deploy the API component.",
"type": "boolean"
},
"lifecycle": {
"description": "Default lifecycle for apps.",
"properties": {
"stack": {
"description": "Stack.",
"type": "string"
},
"stagingRequirements": {
"properties": {
"buildCacheMB": {
"description": "Persistent disk in MB for caching staging artifacts across builds.",
"type": "integer"
},
"diskMB": {
"description": "Disk in MB for staging.",
"type": "integer"
},
"memoryMB": {
"description": "Memory in MB for staging.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskMB",
"buildCacheMB"
],
"type": "object"
},
"type": {
"description": "Lifecycle type (only `buildpack` accepted currently).",
"enum": [
"buildpack"
],
"type": "string"
}
},
"required": [
"type",
"stack",
"stagingRequirements"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"userCertificateExpirationWarningDuration": {
"description": "Issue a warning if the user certificate provided for login has a long expiry. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format.",
"type": "string"
}
},
"required": [
"include",
"expose",
"apiServer",
"image",
"lifecycle",
"builderName",
"userCertificateExpirationWarningDuration"
],
"type": "object"
},
"contourRouter": {
"properties": {
"include": {
"description": "Deploy the `contour-router` component.",
"type": "boolean"
}
},
"required": [
"include"
],
"type": "object"
},
"controllers": {
"properties": {
"extraVCAPApplicationValues": {
"description": "Key-value pairs that are going to be set in the VCAP_APPLICATION env var on apps. Nested values are not supported.",
"properties": {},
"type": "object"
},
"image": {
"description": "Reference to the controllers container image.",
"type": "string"
},
"maxRetainedBuildsPerApp": {
"description": "How many staged builds to keep, excluding the app's current droplet. Older staged builds will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"maxRetainedPackagesPerApp": {
"description": "How many 'ready' packages to keep, excluding the package associated with the app's current droplet. Older 'ready' packages will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"namespaceLabels": {
"description": "Key-value pairs that are going to be set as labels on the namespaces created by Korifi.",
"properties": {},
"type": "object"
},
"processDefaults": {
"properties": {
"diskQuotaMB": {
"description": "Default disk quota for the `web` process.",
"type": "integer"
},
"memoryMB": {
"description": "Default memory limit for the `web` process.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskQuotaMB"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"taskTTL": {
"description": "How long before the `CFTask` object is deleted after the task has completed. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"workloadsTLSSecret": {
"description": "TLS secret used when setting up an app routes.",
"type": "string"
}
},
"required": [
"image",
"taskTTL",
"workloadsTLSSecret"
],
"type": "object"
},
"global": {
"description": "Global values that are shared between Korifi and its subcharts.",
"properties": {
"containerRegistrySecret": {
"description": "Name of the `Secret` to use when pushing or pulling from package, droplet and kpack-build repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"type": "string"
},
"containerRepositoryPrefix": {
"description": "The prefix of the container repository where package and droplet images will be pushed. This is suffixed with the app GUID and `-packages` or `-droplets`. For example, a value of `index.docker.io/korifi/` will result in `index.docker.io/korifi/<appGUID>-packages` and `index.docker.io/korifi/<appGUID>-droplets` being pushed.",
"pattern": "^[a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*/?$",
"type": "string"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"logLevel": {
"description": "Sets level of logging for api and controllers components. Can be 'info' or 'debug'.",
"enum": [
"info",
"debug"
],
"type": "string"
},
"reconcilers": {
"properties": {
"app": {
"description": "ID of the workload runner to set on all `AppWorkload` objects. Defaults to `statefulset-runner`.",
"type": "string"
},
"build": {
"description": "ID of the image builder to set on all `BuildWorkload` objects. Has to match `api.builderName`. Defaults to `kpack-image-builder`.",
"type": "string"
}
},
"required": [
"build",
"run"
],
"type": "object"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
}
},
"required": [
"containerRepositoryPrefix",
"defaultAppDomainName",
"logLevel",
"reconcilers",
"rootNamespace"
],
"type": "object"
},
"jobTaskRunner": {
"properties": {
"include": {
"description": "Deploy the `job-task-runner` component.",
"type": "boolean"
},
"jobTTL": {
"description": "How long before the `Job` backing up a task is deleted after completion. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"jobTTL"
],
"type": "object"
},
"kpackImageBuilder": {
"properties": {
"builderReadinessTimeout": {
"description": "The time that the kpack Builder will be waited for if not in ready state, berfore the build workload fails. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"builderRepository": {
"description": "Container image repository to store the `ClusterBuilder` image. Required when `clusterBuilderName` is not provided.",
"pattern": "^([a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*)?$",
"type": "string"
},
"clusterBuilderName": {
"description": "The name of the `ClusterBuilder` Kpack has been configured with. Leave blank to let `kpack-image-builder` create an example `ClusterBuilder`.",
"type": "string"
},
"clusterStackBuildImage": {
"description": "The image to use for building defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"clusterStackRunImage": {
"description": "The image to use for running defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"include": {
"description": "Deploy the `kpack-image-builder` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"builderReadinessTimeout"
],
"type": "object"
},
"statefulsetRunner": {
"properties": {
"include": {
"description": "Deploy the `statefulset-runner` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
}
},
"required": [
"global",
"adminUserName",
"api",
"controllers",
"kpackImageBuilder",
"statefulsetRunner",
"jobTaskRunner"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | 1c87dd5dbd35096342760cac1d186c08eb8d8d7f | 2023-07-13T17:51:32 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"api": {
"properties": {
"apiServer": {
"properties": {
"internalPort": {
"description": "Port used internally by the API container.",
"type": "integer"
},
"port": {
"description": "API external port. Defaults to `443`.",
"type": "integer"
},
"timeouts": {
"description": "HTTP timeouts.",
"properties": {
"idle": {
"description": "Idle timeout.",
"type": "integer"
},
"read": {
"description": "Read timeout.",
"type": "integer"
},
"readHeader": {
"description": "Read header timeout.",
"type": "integer"
},
"write": {
"description": "Write timeout.",
"type": "integer"
}
},
"required": [
"read",
"write",
"idle",
"readHeader"
],
"type": "object"
},
"url": {
"description": "API URL.",
"type": "string"
}
},
"required": [
"url",
"port",
"internalPort",
"timeouts"
],
"type": "object"
},
"authProxy": {
"description": "Needed if using a cluster authentication proxy, e.g. [Pinniped](https://pinniped.dev/).",
"properties": {
"caCert": {
"description": "Proxy's PEM-encoded CA certificate (*not* as Base64).",
"type": "string"
},
"host": {
"description": "Must be a host string, a host:port pair, or a URL to the base of the apiserver.",
"type": "string"
}
},
"type": "object"
},
"builderName": {
"description": "ID of the builder used to build apps. Defaults to `kpack-image-builder`.",
"type": "string"
},
"expose": {
"description": "Expose the API component via Contour. Set to false if you want to expose the API using other means.",
"type": "boolean"
},
"image": {
"description": "Reference to the API container image.",
"type": "string"
},
"include": {
"description": "Deploy the API component.",
"type": "boolean"
},
"lifecycle": {
"description": "Default lifecycle for apps.",
"properties": {
"stack": {
"description": "Stack.",
"type": "string"
},
"stagingRequirements": {
"properties": {
"buildCacheMB": {
"description": "Persistent disk in MB for caching staging artifacts across builds.",
"type": "integer"
},
"diskMB": {
"description": "Ephemeral Disk request in MB for staging apps.",
"type": "integer"
},
"memoryMB": {
"description": "Memory request in MB for staging.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskMB",
"buildCacheMB"
],
"type": "object"
},
"type": {
"description": "Lifecycle type (only `buildpack` accepted currently).",
"enum": [
"buildpack"
],
"type": "string"
}
},
"required": [
"type",
"stack",
"stagingRequirements"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"userCertificateExpirationWarningDuration": {
"description": "Issue a warning if the user certificate provided for login has a long expiry. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format.",
"type": "string"
}
},
"required": [
"include",
"expose",
"apiServer",
"image",
"lifecycle",
"builderName",
"userCertificateExpirationWarningDuration"
],
"type": "object"
},
"contourRouter": {
"properties": {
"include": {
"description": "Deploy the `contour-router` component.",
"type": "boolean"
}
},
"required": [
"include"
],
"type": "object"
},
"controllers": {
"properties": {
"extraVCAPApplicationValues": {
"description": "Key-value pairs that are going to be set in the VCAP_APPLICATION env var on apps. Nested values are not supported.",
"properties": {},
"type": "object"
},
"image": {
"description": "Reference to the controllers container image.",
"type": "string"
},
"maxRetainedBuildsPerApp": {
"description": "How many staged builds to keep, excluding the app's current droplet. Older staged builds will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"maxRetainedPackagesPerApp": {
"description": "How many 'ready' packages to keep, excluding the package associated with the app's current droplet. Older 'ready' packages will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"namespaceLabels": {
"description": "Key-value pairs that are going to be set as labels on the namespaces created by Korifi.",
"properties": {},
"type": "object"
},
"processDefaults": {
"properties": {
"diskQuotaMB": {
"description": "Default disk quota for the `web` process.",
"type": "integer"
},
"memoryMB": {
"description": "Default memory limit for the `web` process.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskQuotaMB"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"taskTTL": {
"description": "How long before the `CFTask` object is deleted after the task has completed. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"workloadsTLSSecret": {
"description": "TLS secret used when setting up an app routes.",
"type": "string"
}
},
"required": [
"image",
"taskTTL",
"workloadsTLSSecret"
],
"type": "object"
},
"global": {
"description": "Global values that are shared between Korifi and its subcharts.",
"properties": {
"containerRegistrySecret": {
"deprecated": true,
"description": "Deprecated in favor of containerRegistrySecrets.",
"type": "string"
},
"containerRegistrySecrets": {
"description": "List of `Secret` names to use when pushing or pulling from package, droplet and kpack builder repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"items": {
"type": "string"
},
"type": "array"
},
"containerRepositoryPrefix": {
"description": "The prefix of the container repository where package and droplet images will be pushed. This is suffixed with the app GUID and `-packages` or `-droplets`. For example, a value of `index.docker.io/korifi/` will result in `index.docker.io/korifi/<appGUID>-packages` and `index.docker.io/korifi/<appGUID>-droplets` being pushed.",
"pattern": "^[a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*/?$",
"type": "string"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"logLevel": {
"description": "Sets level of logging for api and controllers components. Can be 'info' or 'debug'.",
"enum": [
"info",
"debug"
],
"type": "string"
},
"reconcilers": {
"properties": {
"app": {
"description": "ID of the workload runner to set on all `AppWorkload` objects. Defaults to `statefulset-runner`.",
"type": "string"
},
"build": {
"description": "ID of the image builder to set on all `BuildWorkload` objects. Has to match `api.builderName`. Defaults to `kpack-image-builder`.",
"type": "string"
}
},
"required": [
"build",
"run"
],
"type": "object"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
}
},
"required": [
"containerRepositoryPrefix",
"defaultAppDomainName",
"logLevel",
"reconcilers",
"rootNamespace"
],
"type": "object"
},
"jobTaskRunner": {
"properties": {
"include": {
"description": "Deploy the `job-task-runner` component.",
"type": "boolean"
},
"jobTTL": {
"description": "How long before the `Job` backing up a task is deleted after completion. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"jobTTL"
],
"type": "object"
},
"kpackImageBuilder": {
"properties": {
"builderReadinessTimeout": {
"description": "The time that the kpack Builder will be waited for if not in ready state, berfore the build workload fails. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"builderRepository": {
"description": "Container image repository to store the `ClusterBuilder` image. Required when `clusterBuilderName` is not provided.",
"pattern": "^([a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*)?$",
"type": "string"
},
"clusterBuilderName": {
"description": "The name of the `ClusterBuilder` Kpack has been configured with. Leave blank to let `kpack-image-builder` create an example `ClusterBuilder`.",
"type": "string"
},
"clusterStackBuildImage": {
"description": "The image to use for building defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"clusterStackRunImage": {
"description": "The image to use for running defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"include": {
"description": "Deploy the `kpack-image-builder` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"builderReadinessTimeout"
],
"type": "object"
},
"statefulsetRunner": {
"properties": {
"include": {
"description": "Deploy the `statefulset-runner` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
}
},
"required": [
"global",
"adminUserName",
"api",
"controllers",
"kpackImageBuilder",
"statefulsetRunner",
"jobTaskRunner"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | 1e0a8a0817eb3f640feeba5acdfc0fcd838b2d35 | 2024-01-10T10:00:36 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"api": {
"properties": {
"apiServer": {
"properties": {
"internalPort": {
"description": "Port used internally by the API container.",
"type": "integer"
},
"port": {
"description": "API external port. Defaults to `443`.",
"type": "integer"
},
"timeouts": {
"description": "HTTP timeouts.",
"properties": {
"idle": {
"description": "Idle timeout.",
"type": "integer"
},
"read": {
"description": "Read timeout.",
"type": "integer"
},
"readHeader": {
"description": "Read header timeout.",
"type": "integer"
},
"write": {
"description": "Write timeout.",
"type": "integer"
}
},
"required": [
"read",
"write",
"idle",
"readHeader"
],
"type": "object"
},
"url": {
"description": "API URL.",
"type": "string"
}
},
"required": [
"url",
"port",
"internalPort",
"timeouts"
],
"type": "object"
},
"authProxy": {
"description": "Needed if using a cluster authentication proxy, e.g. [Pinniped](https://pinniped.dev/).",
"properties": {
"caCert": {
"description": "Proxy's PEM-encoded CA certificate (*not* as Base64).",
"type": "string"
},
"host": {
"description": "Must be a host string, a host:port pair, or a URL to the base of the apiserver.",
"type": "string"
}
},
"type": "object"
},
"image": {
"description": "Reference to the API container image.",
"type": "string"
},
"include": {
"description": "Deploy the API component.",
"type": "boolean"
},
"lifecycle": {
"description": "Default lifecycle for apps.",
"properties": {
"stack": {
"description": "Stack.",
"type": "string"
},
"type": {
"description": "Lifecycle type (only `buildpack` accepted currently).",
"enum": [
"buildpack"
],
"type": "string"
}
},
"required": [
"type",
"stack"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"userCertificateExpirationWarningDuration": {
"description": "Issue a warning if the user certificate provided for login has a long expiry. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format.",
"type": "string"
}
},
"required": [
"include",
"apiServer",
"image",
"lifecycle",
"userCertificateExpirationWarningDuration"
],
"type": "object"
},
"containerRegistrySecret": {
"deprecated": true,
"description": "Deprecated in favor of containerRegistrySecrets.",
"type": "string"
},
"containerRegistrySecrets": {
"description": "List of `Secret` names to use when pushing or pulling from package, droplet and kpack builder repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"items": {
"type": "string"
},
"type": "array"
},
"containerRepositoryPrefix": {
"description": "The prefix of the container repository where package and droplet images will be pushed. This is suffixed with the app GUID and `-packages` or `-droplets`. For example, a value of `index.docker.io/korifi/` will result in `index.docker.io/korifi/<appGUID>-packages` and `index.docker.io/korifi/<appGUID>-droplets` being pushed.",
"pattern": "^[a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*/?$",
"type": "string"
},
"contourRouter": {
"properties": {
"include": {
"description": "Deploy the `contour-router` component.",
"type": "boolean"
}
},
"required": [
"include"
],
"type": "object"
},
"controllers": {
"properties": {
"extraVCAPApplicationValues": {
"description": "Key-value pairs that are going to be set in the VCAP_APPLICATION env var on apps. Nested values are not supported.",
"properties": {},
"type": "object"
},
"image": {
"description": "Reference to the controllers container image.",
"type": "string"
},
"maxRetainedBuildsPerApp": {
"description": "How many staged builds to keep, excluding the app's current droplet. Older staged builds will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"maxRetainedPackagesPerApp": {
"description": "How many 'ready' packages to keep, excluding the package associated with the app's current droplet. Older 'ready' packages will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"namespaceLabels": {
"description": "Key-value pairs that are going to be set as labels on the namespaces created by Korifi.",
"properties": {},
"type": "object"
},
"processDefaults": {
"properties": {
"diskQuotaMB": {
"description": "Default disk quota for the `web` process.",
"type": "integer"
},
"memoryMB": {
"description": "Default memory limit for the `web` process.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskQuotaMB"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"taskTTL": {
"description": "How long before the `CFTask` object is deleted after the task has completed. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"workloadsTLSSecret": {
"description": "TLS secret used when setting up an app routes.",
"type": "string"
}
},
"required": [
"image",
"taskTTL",
"workloadsTLSSecret"
],
"type": "object"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"helm": {
"properties": {
"hooksImage": {
"description": "Image for the helm hooks containing kubectl",
"type": "string"
}
},
"type": "object"
},
"jobTaskRunner": {
"properties": {
"include": {
"description": "Deploy the `job-task-runner` component.",
"type": "boolean"
},
"jobTTL": {
"description": "How long before the `Job` backing up a task is deleted after completion. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"jobTTL"
],
"type": "object"
},
"kpackImageBuilder": {
"properties": {
"builderReadinessTimeout": {
"description": "The time that the kpack Builder will be waited for if not in ready state, berfore the build workload fails. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"builderRepository": {
"description": "Container image repository to store the `ClusterBuilder` image. Required when `clusterBuilderName` is not provided.",
"pattern": "^([a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*)?$",
"type": "string"
},
"clusterBuilderName": {
"description": "The name of the `ClusterBuilder` Kpack has been configured with. Leave blank to let `kpack-image-builder` create an example `ClusterBuilder`.",
"type": "string"
},
"clusterStackBuildImage": {
"description": "The image to use for building defined in the `ClusterStack`. Used when `clusterBuilderName` is blank.",
"type": "string"
},
"clusterStackID": {
"description": "The ID of the `ClusterStack`. Used when `clusterBuilderName` is blank.",
"type": "string"
},
"clusterStackRunImage": {
"description": "The image to use for running defined in the `ClusterStack`. Used when `clusterBuilderName` is blank.",
"type": "string"
},
"include": {
"description": "Deploy the `kpack-image-builder` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"builderReadinessTimeout"
],
"type": "object"
},
"logLevel": {
"description": "Sets level of logging for api and controllers components. Can be 'info' or 'debug'.",
"enum": [
"info",
"debug"
],
"type": "string"
},
"networking": {
"description": "Networking configuration",
"properties": {
"gatewayClass": {
"description": "The name of the GatewayClass Korifi Gateway references",
"type": "string"
}
},
"required": [
"gatewayClass"
],
"type": "object"
},
"reconcilers": {
"properties": {
"app": {
"description": "ID of the workload runner to set on all `AppWorkload` objects. Defaults to `statefulset-runner`.",
"type": "string"
},
"build": {
"description": "ID of the image builder to set on all `BuildWorkload` objects. Defaults to `kpack-image-builder`.",
"type": "string"
}
},
"required": [
"build",
"run"
],
"type": "object"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
},
"stagingRequirements": {
"properties": {
"buildCacheMB": {
"description": "Persistent disk in MB for caching staging artifacts across builds.",
"type": "integer"
},
"diskMB": {
"description": "Ephemeral Disk request in MB for staging apps.",
"type": "integer"
},
"memoryMB": {
"description": "Memory request in MB for staging.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskMB",
"buildCacheMB"
],
"type": "object"
},
"statefulsetRunner": {
"properties": {
"include": {
"description": "Deploy the `statefulset-runner` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
},
"systemImagePullSecrets": {
"description": "List of `Secret` names to be used when pulling Korifi system images from private registries",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"adminUserName",
"containerRepositoryPrefix",
"defaultAppDomainName",
"logLevel",
"reconcilers",
"rootNamespace",
"stagingRequirements",
"api",
"controllers",
"kpackImageBuilder",
"statefulsetRunner",
"jobTaskRunner"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | f43aa0f329afd3322d071ebca97ffe3b906f67da | 2023-07-07T23:10:40 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"api": {
"properties": {
"apiServer": {
"properties": {
"internalPort": {
"description": "Port used internally by the API container.",
"type": "integer"
},
"port": {
"description": "API external port. Defaults to `443`.",
"type": "integer"
},
"timeouts": {
"description": "HTTP timeouts.",
"properties": {
"idle": {
"description": "Idle timeout.",
"type": "integer"
},
"read": {
"description": "Read timeout.",
"type": "integer"
},
"readHeader": {
"description": "Read header timeout.",
"type": "integer"
},
"write": {
"description": "Write timeout.",
"type": "integer"
}
},
"required": [
"read",
"write",
"idle",
"readHeader"
],
"type": "object"
},
"url": {
"description": "API URL.",
"type": "string"
}
},
"required": [
"url",
"port",
"internalPort",
"timeouts"
],
"type": "object"
},
"authProxy": {
"description": "Needed if using a cluster authentication proxy, e.g. [Pinniped](https://pinniped.dev/).",
"properties": {
"caCert": {
"description": "Proxy's PEM-encoded CA certificate (*not* as Base64).",
"type": "string"
},
"host": {
"description": "Must be a host string, a host:port pair, or a URL to the base of the apiserver.",
"type": "string"
}
},
"type": "object"
},
"builderName": {
"description": "ID of the builder used to build apps. Defaults to `kpack-image-builder`.",
"type": "string"
},
"expose": {
"description": "Expose the API component via Contour. Set to false if you want to expose the API using other means.",
"type": "boolean"
},
"image": {
"description": "Reference to the API container image.",
"type": "string"
},
"include": {
"description": "Deploy the API component.",
"type": "boolean"
},
"lifecycle": {
"description": "Default lifecycle for apps.",
"properties": {
"stack": {
"description": "Stack.",
"type": "string"
},
"stagingRequirements": {
"properties": {
"buildCacheMB": {
"description": "Persistent disk in MB for caching staging artifacts across builds.",
"type": "integer"
},
"diskMB": {
"description": "Ephemeral Disk limit in MB for staging apps.",
"type": "integer"
},
"memoryMB": {
"description": "Memory in MB for staging.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskMB",
"buildCacheMB"
],
"type": "object"
},
"type": {
"description": "Lifecycle type (only `buildpack` accepted currently).",
"enum": [
"buildpack"
],
"type": "string"
}
},
"required": [
"type",
"stack",
"stagingRequirements"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"userCertificateExpirationWarningDuration": {
"description": "Issue a warning if the user certificate provided for login has a long expiry. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format.",
"type": "string"
}
},
"required": [
"include",
"expose",
"apiServer",
"image",
"lifecycle",
"builderName",
"userCertificateExpirationWarningDuration"
],
"type": "object"
},
"contourRouter": {
"properties": {
"include": {
"description": "Deploy the `contour-router` component.",
"type": "boolean"
}
},
"required": [
"include"
],
"type": "object"
},
"controllers": {
"properties": {
"extraVCAPApplicationValues": {
"description": "Key-value pairs that are going to be set in the VCAP_APPLICATION env var on apps. Nested values are not supported.",
"properties": {},
"type": "object"
},
"image": {
"description": "Reference to the controllers container image.",
"type": "string"
},
"maxRetainedBuildsPerApp": {
"description": "How many staged builds to keep, excluding the app's current droplet. Older staged builds will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"maxRetainedPackagesPerApp": {
"description": "How many 'ready' packages to keep, excluding the package associated with the app's current droplet. Older 'ready' packages will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"namespaceLabels": {
"description": "Key-value pairs that are going to be set as labels on the namespaces created by Korifi.",
"properties": {},
"type": "object"
},
"processDefaults": {
"properties": {
"diskQuotaMB": {
"description": "Default disk quota for the `web` process.",
"type": "integer"
},
"memoryMB": {
"description": "Default memory limit for the `web` process.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskQuotaMB"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"taskTTL": {
"description": "How long before the `CFTask` object is deleted after the task has completed. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"workloadsTLSSecret": {
"description": "TLS secret used when setting up an app routes.",
"type": "string"
}
},
"required": [
"image",
"taskTTL",
"workloadsTLSSecret"
],
"type": "object"
},
"global": {
"description": "Global values that are shared between Korifi and its subcharts.",
"properties": {
"containerRegistrySecret": {
"deprecated": true,
"description": "Deprecated in favor of containerRegistrySecrets.",
"type": "string"
},
"containerRegistrySecrets": {
"description": "List of `Secret` names to use when pushing or pulling from package, droplet and kpack builder repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"items": {
"type": "string"
},
"type": "array"
},
"containerRepositoryPrefix": {
"description": "The prefix of the container repository where package and droplet images will be pushed. This is suffixed with the app GUID and `-packages` or `-droplets`. For example, a value of `index.docker.io/korifi/` will result in `index.docker.io/korifi/<appGUID>-packages` and `index.docker.io/korifi/<appGUID>-droplets` being pushed.",
"pattern": "^[a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*/?$",
"type": "string"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"logLevel": {
"description": "Sets level of logging for api and controllers components. Can be 'info' or 'debug'.",
"enum": [
"info",
"debug"
],
"type": "string"
},
"reconcilers": {
"properties": {
"app": {
"description": "ID of the workload runner to set on all `AppWorkload` objects. Defaults to `statefulset-runner`.",
"type": "string"
},
"build": {
"description": "ID of the image builder to set on all `BuildWorkload` objects. Has to match `api.builderName`. Defaults to `kpack-image-builder`.",
"type": "string"
}
},
"required": [
"build",
"run"
],
"type": "object"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
}
},
"required": [
"containerRepositoryPrefix",
"defaultAppDomainName",
"logLevel",
"reconcilers",
"rootNamespace"
],
"type": "object"
},
"jobTaskRunner": {
"properties": {
"include": {
"description": "Deploy the `job-task-runner` component.",
"type": "boolean"
},
"jobTTL": {
"description": "How long before the `Job` backing up a task is deleted after completion. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"jobTTL"
],
"type": "object"
},
"kpackImageBuilder": {
"properties": {
"builderReadinessTimeout": {
"description": "The time that the kpack Builder will be waited for if not in ready state, berfore the build workload fails. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"builderRepository": {
"description": "Container image repository to store the `ClusterBuilder` image. Required when `clusterBuilderName` is not provided.",
"pattern": "^([a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*)?$",
"type": "string"
},
"clusterBuilderName": {
"description": "The name of the `ClusterBuilder` Kpack has been configured with. Leave blank to let `kpack-image-builder` create an example `ClusterBuilder`.",
"type": "string"
},
"clusterStackBuildImage": {
"description": "The image to use for building defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"clusterStackRunImage": {
"description": "The image to use for running defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"include": {
"description": "Deploy the `kpack-image-builder` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"builderReadinessTimeout"
],
"type": "object"
},
"statefulsetRunner": {
"properties": {
"include": {
"description": "Deploy the `statefulset-runner` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
}
},
"required": [
"global",
"adminUserName",
"api",
"controllers",
"kpackImageBuilder",
"statefulsetRunner",
"jobTaskRunner"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.